From d2a8a49e10f9b408cc754586b15a82f9934a069e Mon Sep 17 00:00:00 2001 From: J H <237805758+jh-db@users.noreply.github.com> Date: Wed, 5 Nov 2025 10:15:06 +0100 Subject: [PATCH 1/7] update sdk to 0.90 --- .codegen/_openapi_sha | 2 +- .../internal/schema/annotations_openapi.yml | 18 ++- .../schema/annotations_openapi_overrides.yml | 4 + .../validation/generated/enum_fields.go | 2 +- bundle/schema/jsonschema.json | 9 +- cmd/account/billable-usage/billable-usage.go | 2 +- cmd/account/budget-policy/budget-policy.go | 8 +- cmd/account/budgets/budgets.go | 2 +- .../csp-enablement-account.go | 2 +- .../custom-app-integration.go | 10 +- .../disable-legacy-features.go | 4 +- .../enable-ip-access-lists.go | 4 +- .../esm-enablement-account.go | 2 +- .../federation-policy/federation-policy.go | 12 +- cmd/account/groups-v2/groups-v2.go | 24 ++-- cmd/account/iam-v2/iam-v2.go | 2 +- .../ip-access-lists/ip-access-lists.go | 6 +- .../llm-proxy-partner-powered-account.go | 2 +- .../llm-proxy-partner-powered-enforce.go | 2 +- cmd/account/log-delivery/log-delivery.go | 8 +- cmd/account/metastores/metastores.go | 2 +- .../network-connectivity.go | 12 +- .../network-policies/network-policies.go | 10 +- cmd/account/networks/networks.go | 4 +- .../o-auth-published-apps.go | 4 +- .../personal-compute/personal-compute.go | 4 +- cmd/account/private-access/private-access.go | 16 +-- .../published-app-integration.go | 6 +- .../service-principal-federation-policy.go | 12 +- .../service-principal-secrets.go | 6 +- .../service-principals-v2.go | 32 +++--- cmd/account/settings-v2/settings-v2.go | 6 +- .../storage-credentials.go | 6 +- cmd/account/storage/storage.go | 2 +- .../usage-dashboards/usage-dashboards.go | 8 +- cmd/account/users-v2/users-v2.go | 46 ++++---- cmd/account/vpc-endpoints/vpc-endpoints.go | 6 +- .../workspace-network-configuration.go | 4 +- cmd/account/workspaces/workspaces.go | 56 +++++----- cmd/workspace/agent-bricks/agent-bricks.go | 2 +- .../aibi-dashboard-embedding-access-policy.go | 4 +- ...bi-dashboard-embedding-approved-domains.go | 4 +- cmd/workspace/alerts-legacy/alerts-legacy.go | 6 +- cmd/workspace/alerts-v2/alerts-v2.go | 20 ++-- cmd/workspace/alerts/alerts.go | 8 +- cmd/workspace/apps-settings/apps-settings.go | 8 +- cmd/workspace/apps/apps.go | 28 ++--- .../automatic-cluster-update.go | 2 +- cmd/workspace/catalogs/catalogs.go | 32 +++--- .../clean-room-asset-revisions.go | 4 +- .../clean-room-assets/clean-room-assets.go | 6 +- .../clean-room-auto-approval-rules.go | 12 +- .../clean-room-task-runs.go | 6 +- cmd/workspace/clean-rooms/clean-rooms.go | 12 +- .../cluster-policies/cluster-policies.go | 28 ++--- cmd/workspace/clusters/clusters.go | 98 ++++++++--------- .../compliance-security-profile.go | 2 +- cmd/workspace/connections/connections.go | 12 +- .../consumer-fulfillments.go | 8 +- .../consumer-installations.go | 16 +-- .../consumer-listings/consumer-listings.go | 18 +-- .../consumer-personalization-requests.go | 16 +-- .../consumer-providers/consumer-providers.go | 6 +- cmd/workspace/credentials/credentials.go | 42 +++---- .../dashboard-email-subscriptions.go | 4 +- .../dashboard-widgets/dashboard-widgets.go | 8 +- cmd/workspace/dashboards/dashboards.go | 12 +- cmd/workspace/data-quality/data-quality.go | 8 +- cmd/workspace/database/database.go | 80 +++++++------- .../default-namespace/default-namespace.go | 4 +- .../default-warehouse-id.go | 4 +- .../disable-legacy-access.go | 4 +- .../disable-legacy-dbfs.go | 4 +- .../enhanced-security-monitoring.go | 2 +- .../entity-tag-assignments.go | 8 +- cmd/workspace/experiments/experiments.go | 104 +++++++++--------- .../external-lineage/external-lineage.go | 4 +- .../external-locations/external-locations.go | 44 ++++---- .../external-metadata/external-metadata.go | 16 +-- .../feature-engineering.go | 22 ++-- cmd/workspace/feature-store/feature-store.go | 8 +- cmd/workspace/forecasting/forecasting.go | 16 +-- cmd/workspace/functions/functions.go | 12 +- cmd/workspace/genie/genie.go | 14 +-- .../git-credentials/git-credentials.go | 20 ++-- .../global-init-scripts.go | 8 +- cmd/workspace/grants/grants.go | 12 +- cmd/workspace/groups-v2/groups-v2.go | 24 ++-- .../instance-pools/instance-pools.go | 22 ++-- .../instance-profiles/instance-profiles.go | 10 +- .../ip-access-lists/ip-access-lists.go | 6 +- cmd/workspace/jobs/jobs.go | 66 +++++------ .../lakeview-embedded/lakeview-embedded.go | 4 +- cmd/workspace/lakeview/lakeview.go | 54 ++++----- .../llm-proxy-partner-powered-workspace.go | 4 +- .../materialized-features.go | 10 +- cmd/workspace/metastores/metastores.go | 28 ++--- .../model-registry/model-registry.go | 58 +++++----- .../model-versions/model-versions.go | 42 +++---- .../notification-destinations.go | 8 +- cmd/workspace/online-tables/online-tables.go | 2 +- .../permission-migration.go | 2 +- cmd/workspace/pipelines/pipelines.go | 58 +++++----- cmd/workspace/policies/policies.go | 28 ++--- .../policy-compliance-for-clusters.go | 6 +- .../policy-compliance-for-jobs.go | 6 +- .../policy-families/policy-families.go | 6 +- .../provider-exchange-filters.go | 4 +- .../provider-exchanges/provider-exchanges.go | 12 +- .../provider-files/provider-files.go | 6 +- .../provider-listings/provider-listings.go | 4 +- .../provider-personalization-requests.go | 6 +- .../provider-provider-analytics-dashboards.go | 2 +- .../provider-providers/provider-providers.go | 4 +- cmd/workspace/providers/providers.go | 30 ++--- .../quality-monitor-v2/quality-monitor-v2.go | 4 +- .../quality-monitors/quality-monitors.go | 16 +-- .../queries-legacy/queries-legacy.go | 30 ++--- cmd/workspace/queries/queries.go | 12 +- cmd/workspace/query-history/query-history.go | 6 +- .../query-visualizations-legacy.go | 16 +-- .../recipient-federation-policies.go | 8 +- cmd/workspace/recipients/recipients.go | 28 ++--- .../registered-models/registered-models.go | 66 +++++------ cmd/workspace/repos/repos.go | 10 +- .../resource-quotas/resource-quotas.go | 4 +- .../restrict-workspace-admins.go | 4 +- cmd/workspace/schemas/schemas.go | 22 ++-- cmd/workspace/secrets/secrets.go | 4 +- .../service-principal-secrets-proxy.go | 6 +- .../service-principals-v2.go | 32 +++--- .../serving-endpoints/serving-endpoints.go | 24 ++-- cmd/workspace/shares/shares.go | 24 ++-- .../sql-results-download.go | 4 +- .../storage-credentials.go | 36 +++--- .../system-schemas/system-schemas.go | 6 +- cmd/workspace/tables/tables.go | 32 +++--- cmd/workspace/tag-policies/tag-policies.go | 8 +- .../temporary-path-credentials.go | 2 +- .../temporary-table-credentials.go | 4 +- .../token-management/token-management.go | 8 +- cmd/workspace/tokens/tokens.go | 4 +- cmd/workspace/users-v2/users-v2.go | 46 ++++---- .../vector-search-endpoints.go | 4 +- .../vector-search-indexes.go | 22 ++-- cmd/workspace/volumes/volumes.go | 18 +-- cmd/workspace/warehouses/warehouses.go | 58 +++++----- .../workspace-bindings/workspace-bindings.go | 4 +- .../workspace-iam-v2/workspace-iam-v2.go | 2 +- .../workspace-settings-v2.go | 6 +- cmd/workspace/workspace/workspace.go | 14 +-- .../bundles/jobs/_models/spark_jar_task.py | 8 +- .../_models/ingestion_source_type.py | 14 +++ go.mod | 2 +- go.sum | 4 +- 155 files changed, 1182 insertions(+), 1137 deletions(-) diff --git a/.codegen/_openapi_sha b/.codegen/_openapi_sha index b7f56b6d8a..19009050ac 100644 --- a/.codegen/_openapi_sha +++ b/.codegen/_openapi_sha @@ -1 +1 @@ -e2018bb00cba203508f8afe5a6d41bd49789ba25 \ No newline at end of file +59c4c0f3d5f0ef00cd5350b5674e941a7606d91a \ No newline at end of file diff --git a/bundle/internal/schema/annotations_openapi.yml b/bundle/internal/schema/annotations_openapi.yml index 9c8a8e413a..6e1b1da081 100644 --- a/bundle/internal/schema/annotations_openapi.yml +++ b/bundle/internal/schema/annotations_openapi.yml @@ -3176,7 +3176,9 @@ github.com/databricks/databricks-sdk-go/service/jobs.Source: github.com/databricks/databricks-sdk-go/service/jobs.SparkJarTask: "jar_uri": "description": |- - Deprecated since 04/2016. Provide a `jar` through the `libraries` field instead. For an example, see :method:jobs/create. + Deprecated since 04/2016. For classic compute, provide a `jar` through the `libraries` field instead. For serverless compute, provide a `jar` though the `java_dependencies` field inside the `environments` list. + + See the examples of classic and serverless compute usage at the top of the page. "deprecation_message": |- This field is deprecated "main_class_name": @@ -3791,6 +3793,20 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionSourceType: CONFLUENCE - |- META_MARKETING + - |- + GOOGLE_ADS + - |- + TIKTOK_ADS + - |- + SALESFORCE_MARKETING_CLOUD + - |- + HUBSPOT + - |- + WORKDAY_HCM + - |- + GUIDEWIRE + - |- + ZENDESK - |- FOREIGN_CATALOG github.com/databricks/databricks-sdk-go/service/pipelines.ManualTrigger: {} diff --git a/bundle/internal/schema/annotations_openapi_overrides.yml b/bundle/internal/schema/annotations_openapi_overrides.yml index 72d50bf2ab..51ed3d0db4 100644 --- a/bundle/internal/schema/annotations_openapi_overrides.yml +++ b/bundle/internal/schema/annotations_openapi_overrides.yml @@ -594,6 +594,10 @@ github.com/databricks/cli/bundle/config/resources.SqlWarehousePermissionLevel: CAN_MONITOR - |- CAN_VIEW +github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable: + "lifecycle": + "description": |- + PLACEHOLDER github.com/databricks/cli/bundle/config/resources.Volume: "_": "markdown_description": |- diff --git a/bundle/internal/validation/generated/enum_fields.go b/bundle/internal/validation/generated/enum_fields.go index 9975314ffc..c8b13327fc 100644 --- a/bundle/internal/validation/generated/enum_fields.go +++ b/bundle/internal/validation/generated/enum_fields.go @@ -116,7 +116,7 @@ var EnumFields = map[string][]string{ "resources.pipelines.*.ingestion_definition.objects[*].report.table_configuration.scd_type": {"APPEND_ONLY", "SCD_TYPE_1", "SCD_TYPE_2"}, "resources.pipelines.*.ingestion_definition.objects[*].schema.table_configuration.scd_type": {"APPEND_ONLY", "SCD_TYPE_1", "SCD_TYPE_2"}, "resources.pipelines.*.ingestion_definition.objects[*].table.table_configuration.scd_type": {"APPEND_ONLY", "SCD_TYPE_1", "SCD_TYPE_2"}, - "resources.pipelines.*.ingestion_definition.source_type": {"BIGQUERY", "CONFLUENCE", "DYNAMICS365", "FOREIGN_CATALOG", "GA4_RAW_DATA", "MANAGED_POSTGRESQL", "META_MARKETING", "MYSQL", "NETSUITE", "ORACLE", "POSTGRESQL", "REDSHIFT", "SALESFORCE", "SERVICENOW", "SHAREPOINT", "SQLDW", "SQLSERVER", "TERADATA", "WORKDAY_RAAS"}, + "resources.pipelines.*.ingestion_definition.source_type": {"BIGQUERY", "CONFLUENCE", "DYNAMICS365", "FOREIGN_CATALOG", "GA4_RAW_DATA", "GOOGLE_ADS", "GUIDEWIRE", "HUBSPOT", "MANAGED_POSTGRESQL", "META_MARKETING", "MYSQL", "NETSUITE", "ORACLE", "POSTGRESQL", "REDSHIFT", "SALESFORCE", "SALESFORCE_MARKETING_CLOUD", "SERVICENOW", "SHAREPOINT", "SQLDW", "SQLSERVER", "TERADATA", "TIKTOK_ADS", "WORKDAY_HCM", "WORKDAY_RAAS", "ZENDESK"}, "resources.pipelines.*.ingestion_definition.table_configuration.scd_type": {"APPEND_ONLY", "SCD_TYPE_1", "SCD_TYPE_2"}, "resources.pipelines.*.restart_window.days_of_week[*]": {"FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY"}, diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index 053a2e3c25..bf02003baf 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -6400,7 +6400,7 @@ "type": "object", "properties": { "jar_uri": { - "description": "Deprecated since 04/2016. Provide a `jar` through the `libraries` field instead. For an example, see :method:jobs/create.", + "description": "Deprecated since 04/2016. For classic compute, provide a `jar` through the `libraries` field instead. For serverless compute, provide a `jar` though the `java_dependencies` field inside the `environments` list.\n\nSee the examples of classic and serverless compute usage at the top of the page.", "$ref": "#/$defs/string", "deprecationMessage": "This field is deprecated", "deprecated": true @@ -7488,6 +7488,13 @@ "DYNAMICS365", "CONFLUENCE", "META_MARKETING", + "GOOGLE_ADS", + "TIKTOK_ADS", + "SALESFORCE_MARKETING_CLOUD", + "HUBSPOT", + "WORKDAY_HCM", + "GUIDEWIRE", + "ZENDESK", "FOREIGN_CATALOG" ] }, diff --git a/cmd/account/billable-usage/billable-usage.go b/cmd/account/billable-usage/billable-usage.go index 4e7949336d..68ce25d7e0 100755 --- a/cmd/account/billable-usage/billable-usage.go +++ b/cmd/account/billable-usage/billable-usage.go @@ -52,7 +52,7 @@ func newDownload() *cobra.Command { var downloadReq billing.DownloadRequest - cmd.Flags().BoolVar(&downloadReq.PersonalData, "personal-data", downloadReq.PersonalData, `Specify whether to include personally identifiable information in the billable usage logs, for example the email addresses of cluster creators.`) + cmd.Flags().BoolVar(&downloadReq.PersonalData, "personal-data", downloadReq.PersonalData, `Specify whether to include personally identifiable information in the billable usage logs, for example the email addresses of cluster creators. Wire name: 'personal_data'.`) cmd.Use = "download START_MONTH END_MONTH" cmd.Short = `Return billable usage logs.` diff --git a/cmd/account/budget-policy/budget-policy.go b/cmd/account/budget-policy/budget-policy.go index a921d9ddfd..6594bbb039 100755 --- a/cmd/account/budget-policy/budget-policy.go +++ b/cmd/account/budget-policy/budget-policy.go @@ -60,7 +60,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: policy - cmd.Flags().StringVar(&createReq.RequestId, "request-id", createReq.RequestId, `A unique identifier for this request.`) + cmd.Flags().StringVar(&createReq.RequestId, "request-id", createReq.RequestId, `A unique identifier for this request. Wire name: 'request_id'.`) cmd.Use = "create" cmd.Short = `Create a budget policy.` @@ -239,8 +239,8 @@ func newList() *cobra.Command { var listReq billing.ListBudgetPoliciesRequest // TODO: complex arg: filter_by - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `The maximum number of budget policies to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A page token, received from a previous ListServerlessPolicies call.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `The maximum number of budget policies to return. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A page token, received from a previous ListServerlessPolicies call. Wire name: 'page_token'.`) // TODO: complex arg: sort_spec cmd.Use = "list" @@ -299,7 +299,7 @@ func newUpdate() *cobra.Command { // TODO: complex arg: limit_config // TODO: array: binding_workspace_ids // TODO: array: custom_tags - cmd.Flags().StringVar(&updateReq.Policy.PolicyName, "policy-name", updateReq.Policy.PolicyName, `The name of the policy.`) + cmd.Flags().StringVar(&updateReq.Policy.PolicyName, "policy-name", updateReq.Policy.PolicyName, `The name of the policy. Wire name: 'policy_name'.`) cmd.Use = "update POLICY_ID" cmd.Short = `Update a budget policy.` diff --git a/cmd/account/budgets/budgets.go b/cmd/account/budgets/budgets.go index 71c4621801..8082c0413f 100755 --- a/cmd/account/budgets/budgets.go +++ b/cmd/account/budgets/budgets.go @@ -240,7 +240,7 @@ func newList() *cobra.Command { var listReq billing.ListBudgetConfigurationsRequest - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A page token received from a previous get all budget configurations call.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A page token received from a previous get all budget configurations call. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `Get all budgets.` diff --git a/cmd/account/csp-enablement-account/csp-enablement-account.go b/cmd/account/csp-enablement-account/csp-enablement-account.go index ce2e00fa48..8c2ccf44ce 100755 --- a/cmd/account/csp-enablement-account/csp-enablement-account.go +++ b/cmd/account/csp-enablement-account/csp-enablement-account.go @@ -57,7 +57,7 @@ func newGet() *cobra.Command { var getReq settings.GetCspEnablementAccountSettingRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the compliance security profile setting for new workspaces.` diff --git a/cmd/account/custom-app-integration/custom-app-integration.go b/cmd/account/custom-app-integration/custom-app-integration.go index 7a7f82e814..d6c6a1a94a 100755 --- a/cmd/account/custom-app-integration/custom-app-integration.go +++ b/cmd/account/custom-app-integration/custom-app-integration.go @@ -61,8 +61,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&createReq.Confidential, "confidential", createReq.Confidential, `This field indicates whether an OAuth client secret is required to authenticate this client.`) - cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `Name of the custom OAuth app.`) + cmd.Flags().BoolVar(&createReq.Confidential, "confidential", createReq.Confidential, `This field indicates whether an OAuth client secret is required to authenticate this client. Wire name: 'confidential'.`) + cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `Name of the custom OAuth app. Wire name: 'name'.`) // TODO: array: redirect_urls // TODO: array: scopes // TODO: complex arg: token_access_policy @@ -245,9 +245,9 @@ func newList() *cobra.Command { var listReq oauth2.ListCustomAppIntegrationsRequest - cmd.Flags().BoolVar(&listReq.IncludeCreatorUsername, "include-creator-username", listReq.IncludeCreatorUsername, ``) - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().BoolVar(&listReq.IncludeCreatorUsername, "include-creator-username", listReq.IncludeCreatorUsername, `Wire name: 'include_creator_username'.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `Get custom oauth app integrations.` diff --git a/cmd/account/disable-legacy-features/disable-legacy-features.go b/cmd/account/disable-legacy-features/disable-legacy-features.go index 063a55c743..4afd0d0981 100755 --- a/cmd/account/disable-legacy-features/disable-legacy-features.go +++ b/cmd/account/disable-legacy-features/disable-legacy-features.go @@ -56,7 +56,7 @@ func newDelete() *cobra.Command { var deleteReq settings.DeleteDisableLegacyFeaturesRequest - cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "delete" cmd.Short = `Delete the disable legacy features setting.` @@ -109,7 +109,7 @@ func newGet() *cobra.Command { var getReq settings.GetDisableLegacyFeaturesRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the disable legacy features setting.` diff --git a/cmd/account/enable-ip-access-lists/enable-ip-access-lists.go b/cmd/account/enable-ip-access-lists/enable-ip-access-lists.go index 5159563179..97db3974c4 100755 --- a/cmd/account/enable-ip-access-lists/enable-ip-access-lists.go +++ b/cmd/account/enable-ip-access-lists/enable-ip-access-lists.go @@ -56,7 +56,7 @@ func newDelete() *cobra.Command { var deleteReq settings.DeleteAccountIpAccessEnableRequest - cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "delete" cmd.Short = `Delete the account IP access toggle setting.` @@ -109,7 +109,7 @@ func newGet() *cobra.Command { var getReq settings.GetAccountIpAccessEnableRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the account IP access toggle setting.` diff --git a/cmd/account/esm-enablement-account/esm-enablement-account.go b/cmd/account/esm-enablement-account/esm-enablement-account.go index 11e8da461c..5fff31857a 100755 --- a/cmd/account/esm-enablement-account/esm-enablement-account.go +++ b/cmd/account/esm-enablement-account/esm-enablement-account.go @@ -55,7 +55,7 @@ func newGet() *cobra.Command { var getReq settings.GetEsmEnablementAccountSettingRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the enhanced security monitoring setting for new workspaces.` diff --git a/cmd/account/federation-policy/federation-policy.go b/cmd/account/federation-policy/federation-policy.go index d7b2e6c13c..f3be4e5eea 100755 --- a/cmd/account/federation-policy/federation-policy.go +++ b/cmd/account/federation-policy/federation-policy.go @@ -108,8 +108,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.PolicyId, "policy-id", createReq.PolicyId, `The identifier for the federation policy.`) - cmd.Flags().StringVar(&createReq.Policy.Description, "description", createReq.Policy.Description, `Description of the federation policy.`) + cmd.Flags().StringVar(&createReq.PolicyId, "policy-id", createReq.PolicyId, `The identifier for the federation policy. Wire name: 'policy_id'.`) + cmd.Flags().StringVar(&createReq.Policy.Description, "description", createReq.Policy.Description, `Description of the federation policy. Wire name: 'description'.`) // TODO: complex arg: oidc_policy cmd.Use = "create" @@ -282,8 +282,8 @@ func newList() *cobra.Command { var listReq oauth2.ListAccountFederationPoliciesRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List account federation policies.` @@ -335,8 +335,8 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.UpdateMask, "update-mask", updateReq.UpdateMask, `The field mask specifies which fields of the policy to update.`) - cmd.Flags().StringVar(&updateReq.Policy.Description, "description", updateReq.Policy.Description, `Description of the federation policy.`) + cmd.Flags().StringVar(&updateReq.UpdateMask, "update-mask", updateReq.UpdateMask, `The field mask specifies which fields of the policy to update. Wire name: 'update_mask'.`) + cmd.Flags().StringVar(&updateReq.Policy.Description, "description", updateReq.Policy.Description, `Description of the federation policy. Wire name: 'description'.`) // TODO: complex arg: oidc_policy cmd.Use = "update POLICY_ID" diff --git a/cmd/account/groups-v2/groups-v2.go b/cmd/account/groups-v2/groups-v2.go index a5f79859b3..137b6313d0 100755 --- a/cmd/account/groups-v2/groups-v2.go +++ b/cmd/account/groups-v2/groups-v2.go @@ -66,9 +66,9 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `String that represents a human-readable group name.`) - cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, ``) - cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks group ID.`) + cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `String that represents a human-readable group name. Wire name: 'displayName'.`) + cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, `Wire name: 'externalId'.`) + cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks group ID. Wire name: 'id'.`) // TODO: array: members // TODO: complex arg: meta // TODO: array: roles @@ -250,13 +250,13 @@ func newList() *cobra.Command { var listReq iam.ListAccountGroupsRequest - cmd.Flags().StringVar(&listReq.Attributes, "attributes", listReq.Attributes, `Comma-separated list of attributes to return in response.`) - cmd.Flags().Int64Var(&listReq.Count, "count", listReq.Count, `Desired number of results per page.`) - cmd.Flags().StringVar(&listReq.ExcludedAttributes, "excluded-attributes", listReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response.`) - cmd.Flags().StringVar(&listReq.Filter, "filter", listReq.Filter, `Query by which the results have to be filtered.`) - cmd.Flags().StringVar(&listReq.SortBy, "sort-by", listReq.SortBy, `Attribute to sort the results.`) - cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]`) - cmd.Flags().Int64Var(&listReq.StartIndex, "start-index", listReq.StartIndex, `Specifies the index of the first result.`) + cmd.Flags().StringVar(&listReq.Attributes, "attributes", listReq.Attributes, `Comma-separated list of attributes to return in response. Wire name: 'attributes'.`) + cmd.Flags().Int64Var(&listReq.Count, "count", listReq.Count, `Desired number of results per page. Wire name: 'count'.`) + cmd.Flags().StringVar(&listReq.ExcludedAttributes, "excluded-attributes", listReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response. Wire name: 'excludedAttributes'.`) + cmd.Flags().StringVar(&listReq.Filter, "filter", listReq.Filter, `Query by which the results have to be filtered. Wire name: 'filter'.`) + cmd.Flags().StringVar(&listReq.SortBy, "sort-by", listReq.SortBy, `Attribute to sort the results. Wire name: 'sortBy'.`) + cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]. Wire name: 'sortOrder'.`) + cmd.Flags().Int64Var(&listReq.StartIndex, "start-index", listReq.StartIndex, `Specifies the index of the first result. Wire name: 'startIndex'.`) cmd.Use = "list" cmd.Short = `List group details.` @@ -385,8 +385,8 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `String that represents a human-readable group name.`) - cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, ``) + cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `String that represents a human-readable group name. Wire name: 'displayName'.`) + cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, `Wire name: 'externalId'.`) // TODO: array: members // TODO: complex arg: meta // TODO: array: roles diff --git a/cmd/account/iam-v2/iam-v2.go b/cmd/account/iam-v2/iam-v2.go index 89e7a2836e..a650d82025 100755 --- a/cmd/account/iam-v2/iam-v2.go +++ b/cmd/account/iam-v2/iam-v2.go @@ -58,7 +58,7 @@ func newGetWorkspaceAccessDetail() *cobra.Command { var getWorkspaceAccessDetailReq iamv2.GetWorkspaceAccessDetailRequest - cmd.Flags().Var(&getWorkspaceAccessDetailReq.View, "view", `Controls what fields are returned. Supported values: [BASIC, FULL]`) + cmd.Flags().Var(&getWorkspaceAccessDetailReq.View, "view", `Controls what fields are returned. Supported values: [BASIC, FULL]. Wire name: 'view'.`) cmd.Use = "get-workspace-access-detail WORKSPACE_ID PRINCIPAL_ID" cmd.Short = `Get workspace access details for a principal.` diff --git a/cmd/account/ip-access-lists/ip-access-lists.go b/cmd/account/ip-access-lists/ip-access-lists.go index 80b7d72857..a0c0092a1a 100755 --- a/cmd/account/ip-access-lists/ip-access-lists.go +++ b/cmd/account/ip-access-lists/ip-access-lists.go @@ -472,10 +472,10 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&updateReq.Enabled, "enabled", updateReq.Enabled, `Specifies whether this IP access list is enabled.`) + cmd.Flags().BoolVar(&updateReq.Enabled, "enabled", updateReq.Enabled, `Specifies whether this IP access list is enabled. Wire name: 'enabled'.`) // TODO: array: ip_addresses - cmd.Flags().StringVar(&updateReq.Label, "label", updateReq.Label, `Label for the IP access list.`) - cmd.Flags().Var(&updateReq.ListType, "list-type", `Supported values: [ALLOW, BLOCK]`) + cmd.Flags().StringVar(&updateReq.Label, "label", updateReq.Label, `Label for the IP access list. Wire name: 'label'.`) + cmd.Flags().Var(&updateReq.ListType, "list-type", `Supported values: [ALLOW, BLOCK]. Wire name: 'list_type'.`) cmd.Use = "update IP_ACCESS_LIST_ID" cmd.Short = `Update access list.` diff --git a/cmd/account/llm-proxy-partner-powered-account/llm-proxy-partner-powered-account.go b/cmd/account/llm-proxy-partner-powered-account/llm-proxy-partner-powered-account.go index ac10c02d56..4af32ba374 100755 --- a/cmd/account/llm-proxy-partner-powered-account/llm-proxy-partner-powered-account.go +++ b/cmd/account/llm-proxy-partner-powered-account/llm-proxy-partner-powered-account.go @@ -54,7 +54,7 @@ func newGet() *cobra.Command { var getReq settings.GetLlmProxyPartnerPoweredAccountRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the enable partner powered AI features account setting.` diff --git a/cmd/account/llm-proxy-partner-powered-enforce/llm-proxy-partner-powered-enforce.go b/cmd/account/llm-proxy-partner-powered-enforce/llm-proxy-partner-powered-enforce.go index 3571fdcc12..6ce844ed4f 100755 --- a/cmd/account/llm-proxy-partner-powered-enforce/llm-proxy-partner-powered-enforce.go +++ b/cmd/account/llm-proxy-partner-powered-enforce/llm-proxy-partner-powered-enforce.go @@ -55,7 +55,7 @@ func newGet() *cobra.Command { var getReq settings.GetLlmProxyPartnerPoweredEnforceRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the enforcement status of partner powered AI features account setting.` diff --git a/cmd/account/log-delivery/log-delivery.go b/cmd/account/log-delivery/log-delivery.go index 747d183666..ba5e7c0dd0 100755 --- a/cmd/account/log-delivery/log-delivery.go +++ b/cmd/account/log-delivery/log-delivery.go @@ -277,10 +277,10 @@ func newList() *cobra.Command { var listReq billing.ListLogDeliveryRequest - cmd.Flags().StringVar(&listReq.CredentialsId, "credentials-id", listReq.CredentialsId, `The Credentials id to filter the search results with.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A page token received from a previous get all budget configurations call.`) - cmd.Flags().Var(&listReq.Status, "status", `The log delivery status to filter the search results with. Supported values: [DISABLED, ENABLED]`) - cmd.Flags().StringVar(&listReq.StorageConfigurationId, "storage-configuration-id", listReq.StorageConfigurationId, `The Storage Configuration id to filter the search results with.`) + cmd.Flags().StringVar(&listReq.CredentialsId, "credentials-id", listReq.CredentialsId, `The Credentials id to filter the search results with. Wire name: 'credentials_id'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A page token received from a previous get all budget configurations call. Wire name: 'page_token'.`) + cmd.Flags().Var(&listReq.Status, "status", `The log delivery status to filter the search results with. Supported values: [DISABLED, ENABLED]. Wire name: 'status'.`) + cmd.Flags().StringVar(&listReq.StorageConfigurationId, "storage-configuration-id", listReq.StorageConfigurationId, `The Storage Configuration id to filter the search results with. Wire name: 'storage_configuration_id'.`) cmd.Use = "list" cmd.Short = `Get all log delivery configurations.` diff --git a/cmd/account/metastores/metastores.go b/cmd/account/metastores/metastores.go index fe3aa6a6a1..0300b5205c 100755 --- a/cmd/account/metastores/metastores.go +++ b/cmd/account/metastores/metastores.go @@ -126,7 +126,7 @@ func newDelete() *cobra.Command { var deleteReq catalog.DeleteAccountMetastoreRequest - cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the metastore is not empty.`) + cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the metastore is not empty. Wire name: 'force'.`) cmd.Use = "delete METASTORE_ID" cmd.Short = `Delete a metastore.` diff --git a/cmd/account/network-connectivity/network-connectivity.go b/cmd/account/network-connectivity/network-connectivity.go index f7e3e66972..46b1161614 100755 --- a/cmd/account/network-connectivity/network-connectivity.go +++ b/cmd/account/network-connectivity/network-connectivity.go @@ -176,9 +176,9 @@ func newCreatePrivateEndpointRule() *cobra.Command { cmd.Flags().Var(&createPrivateEndpointRuleJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: domain_names - cmd.Flags().StringVar(&createPrivateEndpointRuleReq.PrivateEndpointRule.EndpointService, "endpoint-service", createPrivateEndpointRuleReq.PrivateEndpointRule.EndpointService, `The full target AWS endpoint service name that connects to the destination resources of the private endpoint.`) - cmd.Flags().StringVar(&createPrivateEndpointRuleReq.PrivateEndpointRule.GroupId, "group-id", createPrivateEndpointRuleReq.PrivateEndpointRule.GroupId, `Not used by customer-managed private endpoint services.`) - cmd.Flags().StringVar(&createPrivateEndpointRuleReq.PrivateEndpointRule.ResourceId, "resource-id", createPrivateEndpointRuleReq.PrivateEndpointRule.ResourceId, `The Azure resource ID of the target resource.`) + cmd.Flags().StringVar(&createPrivateEndpointRuleReq.PrivateEndpointRule.EndpointService, "endpoint-service", createPrivateEndpointRuleReq.PrivateEndpointRule.EndpointService, `The full target AWS endpoint service name that connects to the destination resources of the private endpoint. Wire name: 'endpoint_service'.`) + cmd.Flags().StringVar(&createPrivateEndpointRuleReq.PrivateEndpointRule.GroupId, "group-id", createPrivateEndpointRuleReq.PrivateEndpointRule.GroupId, `Not used by customer-managed private endpoint services. Wire name: 'group_id'.`) + cmd.Flags().StringVar(&createPrivateEndpointRuleReq.PrivateEndpointRule.ResourceId, "resource-id", createPrivateEndpointRuleReq.PrivateEndpointRule.ResourceId, `The Azure resource ID of the target resource. Wire name: 'resource_id'.`) // TODO: array: resource_names cmd.Use = "create-private-endpoint-rule NETWORK_CONNECTIVITY_CONFIG_ID" @@ -491,7 +491,7 @@ func newListNetworkConnectivityConfigurations() *cobra.Command { var listNetworkConnectivityConfigurationsReq settings.ListNetworkConnectivityConfigurationsRequest - cmd.Flags().StringVar(&listNetworkConnectivityConfigurationsReq.PageToken, "page-token", listNetworkConnectivityConfigurationsReq.PageToken, `Pagination token to go to next page based on previous query.`) + cmd.Flags().StringVar(&listNetworkConnectivityConfigurationsReq.PageToken, "page-token", listNetworkConnectivityConfigurationsReq.PageToken, `Pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list-network-connectivity-configurations" cmd.Short = `List network connectivity configurations.` @@ -541,7 +541,7 @@ func newListPrivateEndpointRules() *cobra.Command { var listPrivateEndpointRulesReq settings.ListPrivateEndpointRulesRequest - cmd.Flags().StringVar(&listPrivateEndpointRulesReq.PageToken, "page-token", listPrivateEndpointRulesReq.PageToken, `Pagination token to go to next page based on previous query.`) + cmd.Flags().StringVar(&listPrivateEndpointRulesReq.PageToken, "page-token", listPrivateEndpointRulesReq.PageToken, `Pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list-private-endpoint-rules NETWORK_CONNECTIVITY_CONFIG_ID" cmd.Short = `List private endpoint rules.` @@ -601,7 +601,7 @@ func newUpdatePrivateEndpointRule() *cobra.Command { cmd.Flags().Var(&updatePrivateEndpointRuleJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: domain_names - cmd.Flags().BoolVar(&updatePrivateEndpointRuleReq.PrivateEndpointRule.Enabled, "enabled", updatePrivateEndpointRuleReq.PrivateEndpointRule.Enabled, `Only used by private endpoints towards an AWS S3 service.`) + cmd.Flags().BoolVar(&updatePrivateEndpointRuleReq.PrivateEndpointRule.Enabled, "enabled", updatePrivateEndpointRuleReq.PrivateEndpointRule.Enabled, `Only used by private endpoints towards an AWS S3 service. Wire name: 'enabled'.`) // TODO: array: resource_names cmd.Use = "update-private-endpoint-rule NETWORK_CONNECTIVITY_CONFIG_ID PRIVATE_ENDPOINT_RULE_ID UPDATE_MASK" diff --git a/cmd/account/network-policies/network-policies.go b/cmd/account/network-policies/network-policies.go index dd0aa95900..6144ae895e 100755 --- a/cmd/account/network-policies/network-policies.go +++ b/cmd/account/network-policies/network-policies.go @@ -66,9 +66,9 @@ func newCreateNetworkPolicyRpc() *cobra.Command { cmd.Flags().Var(&createNetworkPolicyRpcJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createNetworkPolicyRpcReq.NetworkPolicy.AccountId, "account-id", createNetworkPolicyRpcReq.NetworkPolicy.AccountId, `The associated account ID for this Network Policy object.`) + cmd.Flags().StringVar(&createNetworkPolicyRpcReq.NetworkPolicy.AccountId, "account-id", createNetworkPolicyRpcReq.NetworkPolicy.AccountId, `The associated account ID for this Network Policy object. Wire name: 'account_id'.`) // TODO: complex arg: egress - cmd.Flags().StringVar(&createNetworkPolicyRpcReq.NetworkPolicy.NetworkPolicyId, "network-policy-id", createNetworkPolicyRpcReq.NetworkPolicy.NetworkPolicyId, `The unique identifier for the network policy.`) + cmd.Flags().StringVar(&createNetworkPolicyRpcReq.NetworkPolicy.NetworkPolicyId, "network-policy-id", createNetworkPolicyRpcReq.NetworkPolicy.NetworkPolicyId, `The unique identifier for the network policy. Wire name: 'network_policy_id'.`) cmd.Use = "create-network-policy-rpc" cmd.Short = `Create a network policy.` @@ -247,7 +247,7 @@ func newListNetworkPoliciesRpc() *cobra.Command { var listNetworkPoliciesRpcReq settings.ListNetworkPoliciesRequest - cmd.Flags().StringVar(&listNetworkPoliciesRpcReq.PageToken, "page-token", listNetworkPoliciesRpcReq.PageToken, `Pagination token to go to next page based on previous query.`) + cmd.Flags().StringVar(&listNetworkPoliciesRpcReq.PageToken, "page-token", listNetworkPoliciesRpcReq.PageToken, `Pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list-network-policies-rpc" cmd.Short = `List network policies.` @@ -301,9 +301,9 @@ func newUpdateNetworkPolicyRpc() *cobra.Command { cmd.Flags().Var(&updateNetworkPolicyRpcJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateNetworkPolicyRpcReq.NetworkPolicy.AccountId, "account-id", updateNetworkPolicyRpcReq.NetworkPolicy.AccountId, `The associated account ID for this Network Policy object.`) + cmd.Flags().StringVar(&updateNetworkPolicyRpcReq.NetworkPolicy.AccountId, "account-id", updateNetworkPolicyRpcReq.NetworkPolicy.AccountId, `The associated account ID for this Network Policy object. Wire name: 'account_id'.`) // TODO: complex arg: egress - cmd.Flags().StringVar(&updateNetworkPolicyRpcReq.NetworkPolicy.NetworkPolicyId, "network-policy-id", updateNetworkPolicyRpcReq.NetworkPolicy.NetworkPolicyId, `The unique identifier for the network policy.`) + cmd.Flags().StringVar(&updateNetworkPolicyRpcReq.NetworkPolicy.NetworkPolicyId, "network-policy-id", updateNetworkPolicyRpcReq.NetworkPolicy.NetworkPolicyId, `The unique identifier for the network policy. Wire name: 'network_policy_id'.`) cmd.Use = "update-network-policy-rpc NETWORK_POLICY_ID" cmd.Short = `Update a network policy.` diff --git a/cmd/account/networks/networks.go b/cmd/account/networks/networks.go index fc4c4bf586..f4af8c7f83 100755 --- a/cmd/account/networks/networks.go +++ b/cmd/account/networks/networks.go @@ -60,11 +60,11 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: gcp_network_info - cmd.Flags().StringVar(&createReq.NetworkName, "network-name", createReq.NetworkName, `The human-readable name of the network configuration.`) + cmd.Flags().StringVar(&createReq.NetworkName, "network-name", createReq.NetworkName, `The human-readable name of the network configuration. Wire name: 'network_name'.`) // TODO: array: security_group_ids // TODO: array: subnet_ids // TODO: complex arg: vpc_endpoints - cmd.Flags().StringVar(&createReq.VpcId, "vpc-id", createReq.VpcId, `The ID of the VPC associated with this network configuration.`) + cmd.Flags().StringVar(&createReq.VpcId, "vpc-id", createReq.VpcId, `The ID of the VPC associated with this network configuration. Wire name: 'vpc_id'.`) cmd.Use = "create" cmd.Short = `Create network configuration.` diff --git a/cmd/account/o-auth-published-apps/o-auth-published-apps.go b/cmd/account/o-auth-published-apps/o-auth-published-apps.go index b0e46d7ea1..87b62fd7af 100755 --- a/cmd/account/o-auth-published-apps/o-auth-published-apps.go +++ b/cmd/account/o-auth-published-apps/o-auth-published-apps.go @@ -54,8 +54,8 @@ func newList() *cobra.Command { var listReq oauth2.ListOAuthPublishedAppsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `The max number of OAuth published apps to return in one page.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A token that can be used to get the next page of results.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `The max number of OAuth published apps to return in one page. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A token that can be used to get the next page of results. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `Get all the published OAuth apps.` diff --git a/cmd/account/personal-compute/personal-compute.go b/cmd/account/personal-compute/personal-compute.go index 611b1dc042..e7006b8e12 100755 --- a/cmd/account/personal-compute/personal-compute.go +++ b/cmd/account/personal-compute/personal-compute.go @@ -63,7 +63,7 @@ func newDelete() *cobra.Command { var deleteReq settings.DeletePersonalComputeSettingRequest - cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "delete" cmd.Short = `Delete Personal Compute setting.` @@ -116,7 +116,7 @@ func newGet() *cobra.Command { var getReq settings.GetPersonalComputeSettingRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get Personal Compute setting.` diff --git a/cmd/account/private-access/private-access.go b/cmd/account/private-access/private-access.go index c054739604..73d1bdf4ea 100755 --- a/cmd/account/private-access/private-access.go +++ b/cmd/account/private-access/private-access.go @@ -60,10 +60,10 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: allowed_vpc_endpoint_ids - cmd.Flags().Var(&createReq.PrivateAccessLevel, "private-access-level", `The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. Supported values: [ACCOUNT, ENDPOINT]`) - cmd.Flags().StringVar(&createReq.PrivateAccessSettingsName, "private-access-settings-name", createReq.PrivateAccessSettingsName, `The human-readable name of the private access settings object.`) - cmd.Flags().BoolVar(&createReq.PublicAccessEnabled, "public-access-enabled", createReq.PublicAccessEnabled, `Determines if the workspace can be accessed over public internet.`) - cmd.Flags().StringVar(&createReq.Region, "region", createReq.Region, `The AWS region for workspaces attached to this private access settings object.`) + cmd.Flags().Var(&createReq.PrivateAccessLevel, "private-access-level", `The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. Supported values: [ACCOUNT, ENDPOINT]. Wire name: 'private_access_level'.`) + cmd.Flags().StringVar(&createReq.PrivateAccessSettingsName, "private-access-settings-name", createReq.PrivateAccessSettingsName, `The human-readable name of the private access settings object. Wire name: 'private_access_settings_name'.`) + cmd.Flags().BoolVar(&createReq.PublicAccessEnabled, "public-access-enabled", createReq.PublicAccessEnabled, `Determines if the workspace can be accessed over public internet. Wire name: 'public_access_enabled'.`) + cmd.Flags().StringVar(&createReq.Region, "region", createReq.Region, `The AWS region for workspaces attached to this private access settings object. Wire name: 'region'.`) cmd.Use = "create" cmd.Short = `Create private access settings.` @@ -286,10 +286,10 @@ func newReplace() *cobra.Command { cmd.Flags().Var(&replaceJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: allowed_vpc_endpoint_ids - cmd.Flags().Var(&replaceReq.CustomerFacingPrivateAccessSettings.PrivateAccessLevel, "private-access-level", `The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. Supported values: [ACCOUNT, ENDPOINT]`) - cmd.Flags().StringVar(&replaceReq.CustomerFacingPrivateAccessSettings.PrivateAccessSettingsName, "private-access-settings-name", replaceReq.CustomerFacingPrivateAccessSettings.PrivateAccessSettingsName, `The human-readable name of the private access settings object.`) - cmd.Flags().BoolVar(&replaceReq.CustomerFacingPrivateAccessSettings.PublicAccessEnabled, "public-access-enabled", replaceReq.CustomerFacingPrivateAccessSettings.PublicAccessEnabled, `Determines if the workspace can be accessed over public internet.`) - cmd.Flags().StringVar(&replaceReq.CustomerFacingPrivateAccessSettings.Region, "region", replaceReq.CustomerFacingPrivateAccessSettings.Region, `The AWS region for workspaces attached to this private access settings object.`) + cmd.Flags().Var(&replaceReq.CustomerFacingPrivateAccessSettings.PrivateAccessLevel, "private-access-level", `The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. Supported values: [ACCOUNT, ENDPOINT]. Wire name: 'private_access_level'.`) + cmd.Flags().StringVar(&replaceReq.CustomerFacingPrivateAccessSettings.PrivateAccessSettingsName, "private-access-settings-name", replaceReq.CustomerFacingPrivateAccessSettings.PrivateAccessSettingsName, `The human-readable name of the private access settings object. Wire name: 'private_access_settings_name'.`) + cmd.Flags().BoolVar(&replaceReq.CustomerFacingPrivateAccessSettings.PublicAccessEnabled, "public-access-enabled", replaceReq.CustomerFacingPrivateAccessSettings.PublicAccessEnabled, `Determines if the workspace can be accessed over public internet. Wire name: 'public_access_enabled'.`) + cmd.Flags().StringVar(&replaceReq.CustomerFacingPrivateAccessSettings.Region, "region", replaceReq.CustomerFacingPrivateAccessSettings.Region, `The AWS region for workspaces attached to this private access settings object. Wire name: 'region'.`) cmd.Use = "replace PRIVATE_ACCESS_SETTINGS_ID" cmd.Short = `Update private access settings.` diff --git a/cmd/account/published-app-integration/published-app-integration.go b/cmd/account/published-app-integration/published-app-integration.go index 417ceead5f..ba27aa3dd0 100755 --- a/cmd/account/published-app-integration/published-app-integration.go +++ b/cmd/account/published-app-integration/published-app-integration.go @@ -61,7 +61,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.AppId, "app-id", createReq.AppId, `App id of the OAuth published app integration.`) + cmd.Flags().StringVar(&createReq.AppId, "app-id", createReq.AppId, `App id of the OAuth published app integration. Wire name: 'app_id'.`) // TODO: complex arg: token_access_policy cmd.Use = "create" @@ -238,8 +238,8 @@ func newList() *cobra.Command { var listReq oauth2.ListPublishedAppIntegrationsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `Get published oauth app integrations.` diff --git a/cmd/account/service-principal-federation-policy/service-principal-federation-policy.go b/cmd/account/service-principal-federation-policy/service-principal-federation-policy.go index e3968e27e9..9efe4c8367 100755 --- a/cmd/account/service-principal-federation-policy/service-principal-federation-policy.go +++ b/cmd/account/service-principal-federation-policy/service-principal-federation-policy.go @@ -115,8 +115,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.PolicyId, "policy-id", createReq.PolicyId, `The identifier for the federation policy.`) - cmd.Flags().StringVar(&createReq.Policy.Description, "description", createReq.Policy.Description, `Description of the federation policy.`) + cmd.Flags().StringVar(&createReq.PolicyId, "policy-id", createReq.PolicyId, `The identifier for the federation policy. Wire name: 'policy_id'.`) + cmd.Flags().StringVar(&createReq.Policy.Description, "description", createReq.Policy.Description, `Description of the federation policy. Wire name: 'description'.`) // TODO: complex arg: oidc_policy cmd.Use = "create SERVICE_PRINCIPAL_ID" @@ -314,8 +314,8 @@ func newList() *cobra.Command { var listReq oauth2.ListServicePrincipalFederationPoliciesRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list SERVICE_PRINCIPAL_ID" cmd.Short = `List service principal federation policies.` @@ -377,8 +377,8 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.UpdateMask, "update-mask", updateReq.UpdateMask, `The field mask specifies which fields of the policy to update.`) - cmd.Flags().StringVar(&updateReq.Policy.Description, "description", updateReq.Policy.Description, `Description of the federation policy.`) + cmd.Flags().StringVar(&updateReq.UpdateMask, "update-mask", updateReq.UpdateMask, `The field mask specifies which fields of the policy to update. Wire name: 'update_mask'.`) + cmd.Flags().StringVar(&updateReq.Policy.Description, "description", updateReq.Policy.Description, `Description of the federation policy. Wire name: 'description'.`) // TODO: complex arg: oidc_policy cmd.Use = "update SERVICE_PRINCIPAL_ID POLICY_ID" diff --git a/cmd/account/service-principal-secrets/service-principal-secrets.go b/cmd/account/service-principal-secrets/service-principal-secrets.go index f811c3f6dd..49e55f2e0e 100755 --- a/cmd/account/service-principal-secrets/service-principal-secrets.go +++ b/cmd/account/service-principal-secrets/service-principal-secrets.go @@ -69,7 +69,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Lifetime, "lifetime", createReq.Lifetime, `The lifetime of the secret in seconds.`) + cmd.Flags().StringVar(&createReq.Lifetime, "lifetime", createReq.Lifetime, `The lifetime of the secret in seconds. Wire name: 'lifetime'.`) cmd.Use = "create SERVICE_PRINCIPAL_ID" cmd.Short = `Create service principal secret.` @@ -197,8 +197,8 @@ func newList() *cobra.Command { var listReq oauth2.ListServicePrincipalSecretsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `An opaque page token which was the next_page_token in the response of the previous request to list the secrets for this service principal.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `An opaque page token which was the next_page_token in the response of the previous request to list the secrets for this service principal. Wire name: 'page_token'.`) cmd.Use = "list SERVICE_PRINCIPAL_ID" cmd.Short = `List service principal secrets.` diff --git a/cmd/account/service-principals-v2/service-principals-v2.go b/cmd/account/service-principals-v2/service-principals-v2.go index 512ecaf204..d66f81b768 100755 --- a/cmd/account/service-principals-v2/service-principals-v2.go +++ b/cmd/account/service-principals-v2/service-principals-v2.go @@ -65,11 +65,11 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&createReq.Active, "active", createReq.Active, `If this user is active.`) - cmd.Flags().StringVar(&createReq.ApplicationId, "application-id", createReq.ApplicationId, `UUID relating to the service principal.`) - cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `String that represents a concatenation of given and family names.`) - cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, ``) - cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks service principal ID.`) + cmd.Flags().BoolVar(&createReq.Active, "active", createReq.Active, `If this user is active. Wire name: 'active'.`) + cmd.Flags().StringVar(&createReq.ApplicationId, "application-id", createReq.ApplicationId, `UUID relating to the service principal. Wire name: 'applicationId'.`) + cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `String that represents a concatenation of given and family names. Wire name: 'displayName'.`) + cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, `Wire name: 'externalId'.`) + cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks service principal ID. Wire name: 'id'.`) // TODO: array: roles cmd.Use = "create" @@ -249,13 +249,13 @@ func newList() *cobra.Command { var listReq iam.ListAccountServicePrincipalsRequest - cmd.Flags().StringVar(&listReq.Attributes, "attributes", listReq.Attributes, `Comma-separated list of attributes to return in response.`) - cmd.Flags().Int64Var(&listReq.Count, "count", listReq.Count, `Desired number of results per page.`) - cmd.Flags().StringVar(&listReq.ExcludedAttributes, "excluded-attributes", listReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response.`) - cmd.Flags().StringVar(&listReq.Filter, "filter", listReq.Filter, `Query by which the results have to be filtered.`) - cmd.Flags().StringVar(&listReq.SortBy, "sort-by", listReq.SortBy, `Attribute to sort the results.`) - cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]`) - cmd.Flags().Int64Var(&listReq.StartIndex, "start-index", listReq.StartIndex, `Specifies the index of the first result.`) + cmd.Flags().StringVar(&listReq.Attributes, "attributes", listReq.Attributes, `Comma-separated list of attributes to return in response. Wire name: 'attributes'.`) + cmd.Flags().Int64Var(&listReq.Count, "count", listReq.Count, `Desired number of results per page. Wire name: 'count'.`) + cmd.Flags().StringVar(&listReq.ExcludedAttributes, "excluded-attributes", listReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response. Wire name: 'excludedAttributes'.`) + cmd.Flags().StringVar(&listReq.Filter, "filter", listReq.Filter, `Query by which the results have to be filtered. Wire name: 'filter'.`) + cmd.Flags().StringVar(&listReq.SortBy, "sort-by", listReq.SortBy, `Attribute to sort the results. Wire name: 'sortBy'.`) + cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]. Wire name: 'sortOrder'.`) + cmd.Flags().Int64Var(&listReq.StartIndex, "start-index", listReq.StartIndex, `Specifies the index of the first result. Wire name: 'startIndex'.`) cmd.Use = "list" cmd.Short = `List service principals.` @@ -383,10 +383,10 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&updateReq.Active, "active", updateReq.Active, `If this user is active.`) - cmd.Flags().StringVar(&updateReq.ApplicationId, "application-id", updateReq.ApplicationId, `UUID relating to the service principal.`) - cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `String that represents a concatenation of given and family names.`) - cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, ``) + cmd.Flags().BoolVar(&updateReq.Active, "active", updateReq.Active, `If this user is active. Wire name: 'active'.`) + cmd.Flags().StringVar(&updateReq.ApplicationId, "application-id", updateReq.ApplicationId, `UUID relating to the service principal. Wire name: 'applicationId'.`) + cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `String that represents a concatenation of given and family names. Wire name: 'displayName'.`) + cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, `Wire name: 'externalId'.`) // TODO: array: roles cmd.Use = "update ID" diff --git a/cmd/account/settings-v2/settings-v2.go b/cmd/account/settings-v2/settings-v2.go index 2811187749..cc97678003 100755 --- a/cmd/account/settings-v2/settings-v2.go +++ b/cmd/account/settings-v2/settings-v2.go @@ -109,8 +109,8 @@ func newListAccountSettingsMetadata() *cobra.Command { var listAccountSettingsMetadataReq settingsv2.ListAccountSettingsMetadataRequest - cmd.Flags().IntVar(&listAccountSettingsMetadataReq.PageSize, "page-size", listAccountSettingsMetadataReq.PageSize, `The maximum number of settings to return.`) - cmd.Flags().StringVar(&listAccountSettingsMetadataReq.PageToken, "page-token", listAccountSettingsMetadataReq.PageToken, `A page token, received from a previous ListAccountSettingsMetadataRequest call.`) + cmd.Flags().IntVar(&listAccountSettingsMetadataReq.PageSize, "page-size", listAccountSettingsMetadataReq.PageSize, `The maximum number of settings to return. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listAccountSettingsMetadataReq.PageToken, "page-token", listAccountSettingsMetadataReq.PageToken, `A page token, received from a previous ListAccountSettingsMetadataRequest call. Wire name: 'page_token'.`) cmd.Use = "list-account-settings-metadata" cmd.Short = `List valid setting keys and their metadata.` @@ -179,7 +179,7 @@ func newPatchPublicAccountSetting() *cobra.Command { // TODO: complex arg: effective_restrict_workspace_admins // TODO: complex arg: effective_string_val // TODO: complex arg: integer_val - cmd.Flags().StringVar(&patchPublicAccountSettingReq.Setting.Name, "name", patchPublicAccountSettingReq.Setting.Name, `Name of the setting.`) + cmd.Flags().StringVar(&patchPublicAccountSettingReq.Setting.Name, "name", patchPublicAccountSettingReq.Setting.Name, `Name of the setting. Wire name: 'name'.`) // TODO: complex arg: personal_compute // TODO: complex arg: restrict_workspace_admins // TODO: complex arg: string_val diff --git a/cmd/account/storage-credentials/storage-credentials.go b/cmd/account/storage-credentials/storage-credentials.go index c2229d378d..a7166b3dbc 100755 --- a/cmd/account/storage-credentials/storage-credentials.go +++ b/cmd/account/storage-credentials/storage-credentials.go @@ -60,7 +60,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: credential_info - cmd.Flags().BoolVar(&createReq.SkipValidation, "skip-validation", createReq.SkipValidation, `Optional, default false.`) + cmd.Flags().BoolVar(&createReq.SkipValidation, "skip-validation", createReq.SkipValidation, `Optional, default false. Wire name: 'skip_validation'.`) cmd.Use = "create METASTORE_ID" cmd.Short = `Create a storage credential.` @@ -135,7 +135,7 @@ func newDelete() *cobra.Command { var deleteReq catalog.DeleteAccountStorageCredentialRequest - cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the Storage Credential is not empty.`) + cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the Storage Credential is not empty. Wire name: 'force'.`) cmd.Use = "delete METASTORE_ID STORAGE_CREDENTIAL_NAME" cmd.Short = `Delete a storage credential.` @@ -314,7 +314,7 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: credential_info - cmd.Flags().BoolVar(&updateReq.SkipValidation, "skip-validation", updateReq.SkipValidation, `Optional.`) + cmd.Flags().BoolVar(&updateReq.SkipValidation, "skip-validation", updateReq.SkipValidation, `Optional. Wire name: 'skip_validation'.`) cmd.Use = "update METASTORE_ID STORAGE_CREDENTIAL_NAME" cmd.Short = `Updates a storage credential.` diff --git a/cmd/account/storage/storage.go b/cmd/account/storage/storage.go index 96f4cf9e6b..9461efcd24 100755 --- a/cmd/account/storage/storage.go +++ b/cmd/account/storage/storage.go @@ -65,7 +65,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.RoleArn, "role-arn", createReq.RoleArn, `Optional IAM role that is used to access the workspace catalog which is created during workspace creation for UC by Default.`) + cmd.Flags().StringVar(&createReq.RoleArn, "role-arn", createReq.RoleArn, `Optional IAM role that is used to access the workspace catalog which is created during workspace creation for UC by Default. Wire name: 'role_arn'.`) cmd.Use = "create" cmd.Short = `Create a storage configuration.` diff --git a/cmd/account/usage-dashboards/usage-dashboards.go b/cmd/account/usage-dashboards/usage-dashboards.go index 9a737e999c..52a379a4a1 100755 --- a/cmd/account/usage-dashboards/usage-dashboards.go +++ b/cmd/account/usage-dashboards/usage-dashboards.go @@ -58,8 +58,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().Var(&createReq.DashboardType, "dashboard-type", `Workspace level usage dashboard shows usage data for the specified workspace ID. Supported values: [USAGE_DASHBOARD_TYPE_GLOBAL, USAGE_DASHBOARD_TYPE_WORKSPACE]`) - cmd.Flags().Int64Var(&createReq.WorkspaceId, "workspace-id", createReq.WorkspaceId, `The workspace ID of the workspace in which the usage dashboard is created.`) + cmd.Flags().Var(&createReq.DashboardType, "dashboard-type", `Workspace level usage dashboard shows usage data for the specified workspace ID. Supported values: [USAGE_DASHBOARD_TYPE_GLOBAL, USAGE_DASHBOARD_TYPE_WORKSPACE]. Wire name: 'dashboard_type'.`) + cmd.Flags().Int64Var(&createReq.WorkspaceId, "workspace-id", createReq.WorkspaceId, `The workspace ID of the workspace in which the usage dashboard is created. Wire name: 'workspace_id'.`) cmd.Use = "create" cmd.Short = `Create new usage dashboard.` @@ -126,8 +126,8 @@ func newGet() *cobra.Command { var getReq billing.GetBillingUsageDashboardRequest - cmd.Flags().Var(&getReq.DashboardType, "dashboard-type", `Workspace level usage dashboard shows usage data for the specified workspace ID. Supported values: [USAGE_DASHBOARD_TYPE_GLOBAL, USAGE_DASHBOARD_TYPE_WORKSPACE]`) - cmd.Flags().Int64Var(&getReq.WorkspaceId, "workspace-id", getReq.WorkspaceId, `The workspace ID of the workspace in which the usage dashboard is created.`) + cmd.Flags().Var(&getReq.DashboardType, "dashboard-type", `Workspace level usage dashboard shows usage data for the specified workspace ID. Supported values: [USAGE_DASHBOARD_TYPE_GLOBAL, USAGE_DASHBOARD_TYPE_WORKSPACE]. Wire name: 'dashboard_type'.`) + cmd.Flags().Int64Var(&getReq.WorkspaceId, "workspace-id", getReq.WorkspaceId, `The workspace ID of the workspace in which the usage dashboard is created. Wire name: 'workspace_id'.`) cmd.Use = "get" cmd.Short = `Get usage dashboard.` diff --git a/cmd/account/users-v2/users-v2.go b/cmd/account/users-v2/users-v2.go index 7a44950b6d..ab495b5919 100755 --- a/cmd/account/users-v2/users-v2.go +++ b/cmd/account/users-v2/users-v2.go @@ -70,14 +70,14 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&createReq.Active, "active", createReq.Active, `If this user is active.`) - cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `String that represents a concatenation of given and family names.`) + cmd.Flags().BoolVar(&createReq.Active, "active", createReq.Active, `If this user is active. Wire name: 'active'.`) + cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `String that represents a concatenation of given and family names. Wire name: 'displayName'.`) // TODO: array: emails - cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, `External ID is not currently supported.`) - cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks user ID.`) + cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, `External ID is not currently supported. Wire name: 'externalId'.`) + cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks user ID. Wire name: 'id'.`) // TODO: complex arg: name // TODO: array: roles - cmd.Flags().StringVar(&createReq.UserName, "user-name", createReq.UserName, `Email address of the Databricks user.`) + cmd.Flags().StringVar(&createReq.UserName, "user-name", createReq.UserName, `Email address of the Databricks user. Wire name: 'userName'.`) cmd.Use = "create" cmd.Short = `Create a new user.` @@ -201,13 +201,13 @@ func newGet() *cobra.Command { var getReq iam.GetAccountUserRequest - cmd.Flags().StringVar(&getReq.Attributes, "attributes", getReq.Attributes, `Comma-separated list of attributes to return in response.`) - cmd.Flags().IntVar(&getReq.Count, "count", getReq.Count, `Desired number of results per page.`) - cmd.Flags().StringVar(&getReq.ExcludedAttributes, "excluded-attributes", getReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response.`) - cmd.Flags().StringVar(&getReq.Filter, "filter", getReq.Filter, `Query by which the results have to be filtered.`) - cmd.Flags().StringVar(&getReq.SortBy, "sort-by", getReq.SortBy, `Attribute to sort the results.`) - cmd.Flags().Var(&getReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]`) - cmd.Flags().IntVar(&getReq.StartIndex, "start-index", getReq.StartIndex, `Specifies the index of the first result.`) + cmd.Flags().StringVar(&getReq.Attributes, "attributes", getReq.Attributes, `Comma-separated list of attributes to return in response. Wire name: 'attributes'.`) + cmd.Flags().IntVar(&getReq.Count, "count", getReq.Count, `Desired number of results per page. Wire name: 'count'.`) + cmd.Flags().StringVar(&getReq.ExcludedAttributes, "excluded-attributes", getReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response. Wire name: 'excludedAttributes'.`) + cmd.Flags().StringVar(&getReq.Filter, "filter", getReq.Filter, `Query by which the results have to be filtered. Wire name: 'filter'.`) + cmd.Flags().StringVar(&getReq.SortBy, "sort-by", getReq.SortBy, `Attribute to sort the results. Wire name: 'sortBy'.`) + cmd.Flags().Var(&getReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]. Wire name: 'sortOrder'.`) + cmd.Flags().IntVar(&getReq.StartIndex, "start-index", getReq.StartIndex, `Specifies the index of the first result. Wire name: 'startIndex'.`) cmd.Use = "get ID" cmd.Short = `Get user details.` @@ -265,13 +265,13 @@ func newList() *cobra.Command { var listReq iam.ListAccountUsersRequest - cmd.Flags().StringVar(&listReq.Attributes, "attributes", listReq.Attributes, `Comma-separated list of attributes to return in response.`) - cmd.Flags().Int64Var(&listReq.Count, "count", listReq.Count, `Desired number of results per page.`) - cmd.Flags().StringVar(&listReq.ExcludedAttributes, "excluded-attributes", listReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response.`) - cmd.Flags().StringVar(&listReq.Filter, "filter", listReq.Filter, `Query by which the results have to be filtered.`) - cmd.Flags().StringVar(&listReq.SortBy, "sort-by", listReq.SortBy, `Attribute to sort the results.`) - cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]`) - cmd.Flags().Int64Var(&listReq.StartIndex, "start-index", listReq.StartIndex, `Specifies the index of the first result.`) + cmd.Flags().StringVar(&listReq.Attributes, "attributes", listReq.Attributes, `Comma-separated list of attributes to return in response. Wire name: 'attributes'.`) + cmd.Flags().Int64Var(&listReq.Count, "count", listReq.Count, `Desired number of results per page. Wire name: 'count'.`) + cmd.Flags().StringVar(&listReq.ExcludedAttributes, "excluded-attributes", listReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response. Wire name: 'excludedAttributes'.`) + cmd.Flags().StringVar(&listReq.Filter, "filter", listReq.Filter, `Query by which the results have to be filtered. Wire name: 'filter'.`) + cmd.Flags().StringVar(&listReq.SortBy, "sort-by", listReq.SortBy, `Attribute to sort the results. Wire name: 'sortBy'.`) + cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]. Wire name: 'sortOrder'.`) + cmd.Flags().Int64Var(&listReq.StartIndex, "start-index", listReq.StartIndex, `Specifies the index of the first result. Wire name: 'startIndex'.`) cmd.Use = "list" cmd.Short = `List users.` @@ -399,13 +399,13 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&updateReq.Active, "active", updateReq.Active, `If this user is active.`) - cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `String that represents a concatenation of given and family names.`) + cmd.Flags().BoolVar(&updateReq.Active, "active", updateReq.Active, `If this user is active. Wire name: 'active'.`) + cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `String that represents a concatenation of given and family names. Wire name: 'displayName'.`) // TODO: array: emails - cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, `External ID is not currently supported.`) + cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, `External ID is not currently supported. Wire name: 'externalId'.`) // TODO: complex arg: name // TODO: array: roles - cmd.Flags().StringVar(&updateReq.UserName, "user-name", updateReq.UserName, `Email address of the Databricks user.`) + cmd.Flags().StringVar(&updateReq.UserName, "user-name", updateReq.UserName, `Email address of the Databricks user. Wire name: 'userName'.`) cmd.Use = "update ID" cmd.Short = `Replace a user.` diff --git a/cmd/account/vpc-endpoints/vpc-endpoints.go b/cmd/account/vpc-endpoints/vpc-endpoints.go index 69a771f588..f2276f5efb 100755 --- a/cmd/account/vpc-endpoints/vpc-endpoints.go +++ b/cmd/account/vpc-endpoints/vpc-endpoints.go @@ -58,10 +58,10 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.AwsVpcEndpointId, "aws-vpc-endpoint-id", createReq.AwsVpcEndpointId, `The ID of the VPC endpoint object in AWS.`) + cmd.Flags().StringVar(&createReq.AwsVpcEndpointId, "aws-vpc-endpoint-id", createReq.AwsVpcEndpointId, `The ID of the VPC endpoint object in AWS. Wire name: 'aws_vpc_endpoint_id'.`) // TODO: complex arg: gcp_vpc_endpoint_info - cmd.Flags().StringVar(&createReq.Region, "region", createReq.Region, `The region in which this VPC endpoint object exists.`) - cmd.Flags().StringVar(&createReq.VpcEndpointName, "vpc-endpoint-name", createReq.VpcEndpointName, `The human-readable name of the storage configuration.`) + cmd.Flags().StringVar(&createReq.Region, "region", createReq.Region, `The region in which this VPC endpoint object exists. Wire name: 'region'.`) + cmd.Flags().StringVar(&createReq.VpcEndpointName, "vpc-endpoint-name", createReq.VpcEndpointName, `The human-readable name of the storage configuration. Wire name: 'vpc_endpoint_name'.`) cmd.Use = "create" cmd.Short = `Create a VPC endpoint configuration.` diff --git a/cmd/account/workspace-network-configuration/workspace-network-configuration.go b/cmd/account/workspace-network-configuration/workspace-network-configuration.go index b01923695c..6fc41a13cd 100755 --- a/cmd/account/workspace-network-configuration/workspace-network-configuration.go +++ b/cmd/account/workspace-network-configuration/workspace-network-configuration.go @@ -126,8 +126,8 @@ func newUpdateWorkspaceNetworkOptionRpc() *cobra.Command { cmd.Flags().Var(&updateWorkspaceNetworkOptionRpcJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateWorkspaceNetworkOptionRpcReq.WorkspaceNetworkOption.NetworkPolicyId, "network-policy-id", updateWorkspaceNetworkOptionRpcReq.WorkspaceNetworkOption.NetworkPolicyId, `The network policy ID to apply to the workspace.`) - cmd.Flags().Int64Var(&updateWorkspaceNetworkOptionRpcReq.WorkspaceNetworkOption.WorkspaceId, "workspace-id", updateWorkspaceNetworkOptionRpcReq.WorkspaceNetworkOption.WorkspaceId, `The workspace ID.`) + cmd.Flags().StringVar(&updateWorkspaceNetworkOptionRpcReq.WorkspaceNetworkOption.NetworkPolicyId, "network-policy-id", updateWorkspaceNetworkOptionRpcReq.WorkspaceNetworkOption.NetworkPolicyId, `The network policy ID to apply to the workspace. Wire name: 'network_policy_id'.`) + cmd.Flags().Int64Var(&updateWorkspaceNetworkOptionRpcReq.WorkspaceNetworkOption.WorkspaceId, "workspace-id", updateWorkspaceNetworkOptionRpcReq.WorkspaceNetworkOption.WorkspaceId, `The workspace ID. Wire name: 'workspace_id'.`) cmd.Use = "update-workspace-network-option-rpc WORKSPACE_ID" cmd.Short = `Update workspace network option.` diff --git a/cmd/account/workspaces/workspaces.go b/cmd/account/workspaces/workspaces.go index 6a360bcd48..500291d599 100755 --- a/cmd/account/workspaces/workspaces.go +++ b/cmd/account/workspaces/workspaces.go @@ -75,19 +75,19 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.AwsRegion, "aws-region", createReq.AwsRegion, ``) - cmd.Flags().StringVar(&createReq.Cloud, "cloud", createReq.Cloud, `The cloud name.`) + cmd.Flags().StringVar(&createReq.AwsRegion, "aws-region", createReq.AwsRegion, `Wire name: 'aws_region'.`) + cmd.Flags().StringVar(&createReq.Cloud, "cloud", createReq.Cloud, `The cloud name. Wire name: 'cloud'.`) // TODO: complex arg: cloud_resource_container - cmd.Flags().Var(&createReq.ComputeMode, "compute-mode", `If the compute mode is SERVERLESS, a serverless workspace is created that comes pre-configured with serverless compute and default storage, providing a fully-managed, enterprise-ready SaaS experience. Supported values: [HYBRID, SERVERLESS]`) - cmd.Flags().StringVar(&createReq.CredentialsId, "credentials-id", createReq.CredentialsId, `ID of the workspace's credential configuration object.`) + cmd.Flags().Var(&createReq.ComputeMode, "compute-mode", `If the compute mode is SERVERLESS, a serverless workspace is created that comes pre-configured with serverless compute and default storage, providing a fully-managed, enterprise-ready SaaS experience. Supported values: [HYBRID, SERVERLESS]. Wire name: 'compute_mode'.`) + cmd.Flags().StringVar(&createReq.CredentialsId, "credentials-id", createReq.CredentialsId, `ID of the workspace's credential configuration object. Wire name: 'credentials_id'.`) // TODO: map via StringToStringVar: custom_tags - cmd.Flags().StringVar(&createReq.DeploymentName, "deployment-name", createReq.DeploymentName, `The deployment name defines part of the subdomain for the workspace.`) + cmd.Flags().StringVar(&createReq.DeploymentName, "deployment-name", createReq.DeploymentName, `The deployment name defines part of the subdomain for the workspace. Wire name: 'deployment_name'.`) // TODO: complex arg: gcp_managed_network_config // TODO: complex arg: gke_config - cmd.Flags().StringVar(&createReq.Location, "location", createReq.Location, `The Google Cloud region of the workspace data plane in your Google account (for example, us-east4).`) - cmd.Flags().StringVar(&createReq.ManagedServicesCustomerManagedKeyId, "managed-services-customer-managed-key-id", createReq.ManagedServicesCustomerManagedKeyId, `The ID of the workspace's managed services encryption key configuration object.`) - cmd.Flags().StringVar(&createReq.NetworkConnectivityConfigId, "network-connectivity-config-id", createReq.NetworkConnectivityConfigId, `The object ID of network connectivity config.`) - cmd.Flags().StringVar(&createReq.NetworkId, "network-id", createReq.NetworkId, `The ID of the workspace's network configuration object.`) + cmd.Flags().StringVar(&createReq.Location, "location", createReq.Location, `The Google Cloud region of the workspace data plane in your Google account (for example, us-east4). Wire name: 'location'.`) + cmd.Flags().StringVar(&createReq.ManagedServicesCustomerManagedKeyId, "managed-services-customer-managed-key-id", createReq.ManagedServicesCustomerManagedKeyId, `The ID of the workspace's managed services encryption key configuration object. Wire name: 'managed_services_customer_managed_key_id'.`) + cmd.Flags().StringVar(&createReq.NetworkConnectivityConfigId, "network-connectivity-config-id", createReq.NetworkConnectivityConfigId, `The object ID of network connectivity config. Wire name: 'network_connectivity_config_id'.`) + cmd.Flags().StringVar(&createReq.NetworkId, "network-id", createReq.NetworkId, `The ID of the workspace's network configuration object. Wire name: 'network_id'.`) cmd.Flags().Var(&createReq.PricingTier, "pricing-tier", `Supported values: [ COMMUNITY_EDITION, DEDICATED, @@ -95,11 +95,11 @@ func newCreate() *cobra.Command { PREMIUM, STANDARD, UNKNOWN, -]`) - cmd.Flags().StringVar(&createReq.PrivateAccessSettingsId, "private-access-settings-id", createReq.PrivateAccessSettingsId, `ID of the workspace's private access settings object.`) - cmd.Flags().StringVar(&createReq.StorageConfigurationId, "storage-configuration-id", createReq.StorageConfigurationId, `ID of the workspace's storage configuration object.`) - cmd.Flags().StringVar(&createReq.StorageCustomerManagedKeyId, "storage-customer-managed-key-id", createReq.StorageCustomerManagedKeyId, `The ID of the workspace's storage encryption key configuration object.`) - cmd.Flags().StringVar(&createReq.WorkspaceName, "workspace-name", createReq.WorkspaceName, `The human-readable name of the workspace.`) +]. Wire name: 'pricing_tier'.`) + cmd.Flags().StringVar(&createReq.PrivateAccessSettingsId, "private-access-settings-id", createReq.PrivateAccessSettingsId, `ID of the workspace's private access settings object. Wire name: 'private_access_settings_id'.`) + cmd.Flags().StringVar(&createReq.StorageConfigurationId, "storage-configuration-id", createReq.StorageConfigurationId, `ID of the workspace's storage configuration object. Wire name: 'storage_configuration_id'.`) + cmd.Flags().StringVar(&createReq.StorageCustomerManagedKeyId, "storage-customer-managed-key-id", createReq.StorageCustomerManagedKeyId, `The ID of the workspace's storage encryption key configuration object. Wire name: 'storage_customer_managed_key_id'.`) + cmd.Flags().StringVar(&createReq.WorkspaceName, "workspace-name", createReq.WorkspaceName, `The human-readable name of the workspace. Wire name: 'workspace_name'.`) cmd.Use = "create" cmd.Short = `Create a workspace.` @@ -384,14 +384,14 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.UpdateMask, "update-mask", updateReq.UpdateMask, `The field mask must be a single string, with multiple fields separated by commas (no spaces).`) - cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.AwsRegion, "aws-region", updateReq.CustomerFacingWorkspace.AwsRegion, ``) + cmd.Flags().StringVar(&updateReq.UpdateMask, "update-mask", updateReq.UpdateMask, `The field mask must be a single string, with multiple fields separated by commas (no spaces). Wire name: 'update_mask'.`) + cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.AwsRegion, "aws-region", updateReq.CustomerFacingWorkspace.AwsRegion, `Wire name: 'aws_region'.`) // TODO: complex arg: azure_workspace_info - cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.Cloud, "cloud", updateReq.CustomerFacingWorkspace.Cloud, `The cloud name.`) + cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.Cloud, "cloud", updateReq.CustomerFacingWorkspace.Cloud, `The cloud name. Wire name: 'cloud'.`) // TODO: complex arg: cloud_resource_container - cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.CredentialsId, "credentials-id", updateReq.CustomerFacingWorkspace.CredentialsId, `ID of the workspace's credential configuration object.`) + cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.CredentialsId, "credentials-id", updateReq.CustomerFacingWorkspace.CredentialsId, `ID of the workspace's credential configuration object. Wire name: 'credentials_id'.`) // TODO: map via StringToStringVar: custom_tags - cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.DeploymentName, "deployment-name", updateReq.CustomerFacingWorkspace.DeploymentName, ``) + cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.DeploymentName, "deployment-name", updateReq.CustomerFacingWorkspace.DeploymentName, `Wire name: 'deployment_name'.`) cmd.Flags().Var(&updateReq.CustomerFacingWorkspace.ExpectedWorkspaceStatus, "expected-workspace-status", `A client owned field used to indicate the workspace status that the client expects to be in. Supported values: [ BANNED, CANCELLING, @@ -399,18 +399,18 @@ func newUpdate() *cobra.Command { NOT_PROVISIONED, PROVISIONING, RUNNING, -]`) +]. Wire name: 'expected_workspace_status'.`) // TODO: complex arg: gcp_managed_network_config // TODO: complex arg: gke_config - cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.Location, "location", updateReq.CustomerFacingWorkspace.Location, `The Google Cloud region of the workspace data plane in your Google account (for example, us-east4).`) - cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.ManagedServicesCustomerManagedKeyId, "managed-services-customer-managed-key-id", updateReq.CustomerFacingWorkspace.ManagedServicesCustomerManagedKeyId, `ID of the key configuration for encrypting managed services.`) + cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.Location, "location", updateReq.CustomerFacingWorkspace.Location, `The Google Cloud region of the workspace data plane in your Google account (for example, us-east4). Wire name: 'location'.`) + cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.ManagedServicesCustomerManagedKeyId, "managed-services-customer-managed-key-id", updateReq.CustomerFacingWorkspace.ManagedServicesCustomerManagedKeyId, `ID of the key configuration for encrypting managed services. Wire name: 'managed_services_customer_managed_key_id'.`) // TODO: complex arg: network - cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.NetworkConnectivityConfigId, "network-connectivity-config-id", updateReq.CustomerFacingWorkspace.NetworkConnectivityConfigId, `The object ID of network connectivity config.`) - cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.NetworkId, "network-id", updateReq.CustomerFacingWorkspace.NetworkId, `If this workspace is BYO VPC, then the network_id will be populated.`) - cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.PrivateAccessSettingsId, "private-access-settings-id", updateReq.CustomerFacingWorkspace.PrivateAccessSettingsId, `ID of the workspace's private access settings object.`) - cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.StorageConfigurationId, "storage-configuration-id", updateReq.CustomerFacingWorkspace.StorageConfigurationId, `ID of the workspace's storage configuration object.`) - cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.StorageCustomerManagedKeyId, "storage-customer-managed-key-id", updateReq.CustomerFacingWorkspace.StorageCustomerManagedKeyId, `ID of the key configuration for encrypting workspace storage.`) - cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.WorkspaceName, "workspace-name", updateReq.CustomerFacingWorkspace.WorkspaceName, `The human-readable name of the workspace.`) + cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.NetworkConnectivityConfigId, "network-connectivity-config-id", updateReq.CustomerFacingWorkspace.NetworkConnectivityConfigId, `The object ID of network connectivity config. Wire name: 'network_connectivity_config_id'.`) + cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.NetworkId, "network-id", updateReq.CustomerFacingWorkspace.NetworkId, `If this workspace is BYO VPC, then the network_id will be populated. Wire name: 'network_id'.`) + cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.PrivateAccessSettingsId, "private-access-settings-id", updateReq.CustomerFacingWorkspace.PrivateAccessSettingsId, `ID of the workspace's private access settings object. Wire name: 'private_access_settings_id'.`) + cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.StorageConfigurationId, "storage-configuration-id", updateReq.CustomerFacingWorkspace.StorageConfigurationId, `ID of the workspace's storage configuration object. Wire name: 'storage_configuration_id'.`) + cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.StorageCustomerManagedKeyId, "storage-customer-managed-key-id", updateReq.CustomerFacingWorkspace.StorageCustomerManagedKeyId, `ID of the key configuration for encrypting workspace storage. Wire name: 'storage_customer_managed_key_id'.`) + cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.WorkspaceName, "workspace-name", updateReq.CustomerFacingWorkspace.WorkspaceName, `The human-readable name of the workspace. Wire name: 'workspace_name'.`) cmd.Use = "update WORKSPACE_ID" cmd.Short = `Update a workspace.` diff --git a/cmd/workspace/agent-bricks/agent-bricks.go b/cmd/workspace/agent-bricks/agent-bricks.go index 3301dc8b75..84d0fe36b6 100755 --- a/cmd/workspace/agent-bricks/agent-bricks.go +++ b/cmd/workspace/agent-bricks/agent-bricks.go @@ -117,7 +117,7 @@ func newCreateCustomLlm() *cobra.Command { cmd.Flags().Var(&createCustomLlmJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createCustomLlmReq.AgentArtifactPath, "agent-artifact-path", createCustomLlmReq.AgentArtifactPath, `This will soon be deprecated!! Optional: UC path for agent artifacts.`) + cmd.Flags().StringVar(&createCustomLlmReq.AgentArtifactPath, "agent-artifact-path", createCustomLlmReq.AgentArtifactPath, `This will soon be deprecated!! Optional: UC path for agent artifacts. Wire name: 'agent_artifact_path'.`) // TODO: array: datasets // TODO: array: guidelines diff --git a/cmd/workspace/aibi-dashboard-embedding-access-policy/aibi-dashboard-embedding-access-policy.go b/cmd/workspace/aibi-dashboard-embedding-access-policy/aibi-dashboard-embedding-access-policy.go index 54a54f5de9..b7e4d28aee 100755 --- a/cmd/workspace/aibi-dashboard-embedding-access-policy/aibi-dashboard-embedding-access-policy.go +++ b/cmd/workspace/aibi-dashboard-embedding-access-policy/aibi-dashboard-embedding-access-policy.go @@ -54,7 +54,7 @@ func newDelete() *cobra.Command { var deleteReq settings.DeleteAibiDashboardEmbeddingAccessPolicySettingRequest - cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "delete" cmd.Short = `Delete the AI/BI dashboard embedding access policy.` @@ -108,7 +108,7 @@ func newGet() *cobra.Command { var getReq settings.GetAibiDashboardEmbeddingAccessPolicySettingRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Retrieve the AI/BI dashboard embedding access policy.` diff --git a/cmd/workspace/aibi-dashboard-embedding-approved-domains/aibi-dashboard-embedding-approved-domains.go b/cmd/workspace/aibi-dashboard-embedding-approved-domains/aibi-dashboard-embedding-approved-domains.go index 75dfcd900a..06bbf2ebfe 100755 --- a/cmd/workspace/aibi-dashboard-embedding-approved-domains/aibi-dashboard-embedding-approved-domains.go +++ b/cmd/workspace/aibi-dashboard-embedding-approved-domains/aibi-dashboard-embedding-approved-domains.go @@ -54,7 +54,7 @@ func newDelete() *cobra.Command { var deleteReq settings.DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest - cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "delete" cmd.Short = `Delete AI/BI dashboard embedding approved domains.` @@ -108,7 +108,7 @@ func newGet() *cobra.Command { var getReq settings.GetAibiDashboardEmbeddingApprovedDomainsSettingRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Retrieve the list of domains approved to host embedded AI/BI dashboards.` diff --git a/cmd/workspace/alerts-legacy/alerts-legacy.go b/cmd/workspace/alerts-legacy/alerts-legacy.go index c5cded70f1..18a656d794 100755 --- a/cmd/workspace/alerts-legacy/alerts-legacy.go +++ b/cmd/workspace/alerts-legacy/alerts-legacy.go @@ -70,8 +70,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Parent, "parent", createReq.Parent, `The identifier of the workspace folder containing the object.`) - cmd.Flags().IntVar(&createReq.Rearm, "rearm", createReq.Rearm, `Number of seconds after being triggered before the alert rearms itself and can be triggered again.`) + cmd.Flags().StringVar(&createReq.Parent, "parent", createReq.Parent, `The identifier of the workspace folder containing the object. Wire name: 'parent'.`) + cmd.Flags().IntVar(&createReq.Rearm, "rearm", createReq.Rearm, `Number of seconds after being triggered before the alert rearms itself and can be triggered again. Wire name: 'rearm'.`) cmd.Use = "create" cmd.Short = `Create an alert.` @@ -309,7 +309,7 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().IntVar(&updateReq.Rearm, "rearm", updateReq.Rearm, `Number of seconds after being triggered before the alert rearms itself and can be triggered again.`) + cmd.Flags().IntVar(&updateReq.Rearm, "rearm", updateReq.Rearm, `Number of seconds after being triggered before the alert rearms itself and can be triggered again. Wire name: 'rearm'.`) cmd.Use = "update ALERT_ID" cmd.Short = `Update an alert.` diff --git a/cmd/workspace/alerts-v2/alerts-v2.go b/cmd/workspace/alerts-v2/alerts-v2.go index 5101177c24..95c0d98344 100755 --- a/cmd/workspace/alerts-v2/alerts-v2.go +++ b/cmd/workspace/alerts-v2/alerts-v2.go @@ -62,12 +62,12 @@ func newCreateAlert() *cobra.Command { cmd.Flags().Var(&createAlertJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createAlertReq.Alert.CustomDescription, "custom-description", createAlertReq.Alert.CustomDescription, `Custom description for the alert.`) - cmd.Flags().StringVar(&createAlertReq.Alert.CustomSummary, "custom-summary", createAlertReq.Alert.CustomSummary, `Custom summary for the alert.`) + cmd.Flags().StringVar(&createAlertReq.Alert.CustomDescription, "custom-description", createAlertReq.Alert.CustomDescription, `Custom description for the alert. Wire name: 'custom_description'.`) + cmd.Flags().StringVar(&createAlertReq.Alert.CustomSummary, "custom-summary", createAlertReq.Alert.CustomSummary, `Custom summary for the alert. Wire name: 'custom_summary'.`) // TODO: complex arg: effective_run_as - cmd.Flags().StringVar(&createAlertReq.Alert.ParentPath, "parent-path", createAlertReq.Alert.ParentPath, `The workspace path of the folder containing the alert.`) + cmd.Flags().StringVar(&createAlertReq.Alert.ParentPath, "parent-path", createAlertReq.Alert.ParentPath, `The workspace path of the folder containing the alert. Wire name: 'parent_path'.`) // TODO: complex arg: run_as - cmd.Flags().StringVar(&createAlertReq.Alert.RunAsUserName, "run-as-user-name", createAlertReq.Alert.RunAsUserName, `The run as username or application ID of service principal.`) + cmd.Flags().StringVar(&createAlertReq.Alert.RunAsUserName, "run-as-user-name", createAlertReq.Alert.RunAsUserName, `The run as username or application ID of service principal. Wire name: 'run_as_user_name'.`) cmd.Use = "create-alert DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE" cmd.Short = `Create an alert.` @@ -235,8 +235,8 @@ func newListAlerts() *cobra.Command { var listAlertsReq sql.ListAlertsV2Request - cmd.Flags().IntVar(&listAlertsReq.PageSize, "page-size", listAlertsReq.PageSize, ``) - cmd.Flags().StringVar(&listAlertsReq.PageToken, "page-token", listAlertsReq.PageToken, ``) + cmd.Flags().IntVar(&listAlertsReq.PageSize, "page-size", listAlertsReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listAlertsReq.PageToken, "page-token", listAlertsReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list-alerts" cmd.Short = `List alerts.` @@ -357,12 +357,12 @@ func newUpdateAlert() *cobra.Command { cmd.Flags().Var(&updateAlertJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateAlertReq.Alert.CustomDescription, "custom-description", updateAlertReq.Alert.CustomDescription, `Custom description for the alert.`) - cmd.Flags().StringVar(&updateAlertReq.Alert.CustomSummary, "custom-summary", updateAlertReq.Alert.CustomSummary, `Custom summary for the alert.`) + cmd.Flags().StringVar(&updateAlertReq.Alert.CustomDescription, "custom-description", updateAlertReq.Alert.CustomDescription, `Custom description for the alert. Wire name: 'custom_description'.`) + cmd.Flags().StringVar(&updateAlertReq.Alert.CustomSummary, "custom-summary", updateAlertReq.Alert.CustomSummary, `Custom summary for the alert. Wire name: 'custom_summary'.`) // TODO: complex arg: effective_run_as - cmd.Flags().StringVar(&updateAlertReq.Alert.ParentPath, "parent-path", updateAlertReq.Alert.ParentPath, `The workspace path of the folder containing the alert.`) + cmd.Flags().StringVar(&updateAlertReq.Alert.ParentPath, "parent-path", updateAlertReq.Alert.ParentPath, `The workspace path of the folder containing the alert. Wire name: 'parent_path'.`) // TODO: complex arg: run_as - cmd.Flags().StringVar(&updateAlertReq.Alert.RunAsUserName, "run-as-user-name", updateAlertReq.Alert.RunAsUserName, `The run as username or application ID of service principal.`) + cmd.Flags().StringVar(&updateAlertReq.Alert.RunAsUserName, "run-as-user-name", updateAlertReq.Alert.RunAsUserName, `The run as username or application ID of service principal. Wire name: 'run_as_user_name'.`) cmd.Use = "update-alert ID UPDATE_MASK DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE" cmd.Short = `Update an alert.` diff --git a/cmd/workspace/alerts/alerts.go b/cmd/workspace/alerts/alerts.go index 4d34182e38..f025fedb38 100755 --- a/cmd/workspace/alerts/alerts.go +++ b/cmd/workspace/alerts/alerts.go @@ -66,7 +66,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: alert - cmd.Flags().BoolVar(&createReq.AutoResolveDisplayName, "auto-resolve-display-name", createReq.AutoResolveDisplayName, `If true, automatically resolve alert display name conflicts.`) + cmd.Flags().BoolVar(&createReq.AutoResolveDisplayName, "auto-resolve-display-name", createReq.AutoResolveDisplayName, `If true, automatically resolve alert display name conflicts. Wire name: 'auto_resolve_display_name'.`) cmd.Use = "create" cmd.Short = `Create an alert.` @@ -264,8 +264,8 @@ func newList() *cobra.Command { var listReq sql.ListAlertsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List alerts.` @@ -321,7 +321,7 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: alert - cmd.Flags().BoolVar(&updateReq.AutoResolveDisplayName, "auto-resolve-display-name", updateReq.AutoResolveDisplayName, `If true, automatically resolve alert display name conflicts.`) + cmd.Flags().BoolVar(&updateReq.AutoResolveDisplayName, "auto-resolve-display-name", updateReq.AutoResolveDisplayName, `If true, automatically resolve alert display name conflicts. Wire name: 'auto_resolve_display_name'.`) cmd.Use = "update ID UPDATE_MASK" cmd.Short = `Update an alert.` diff --git a/cmd/workspace/apps-settings/apps-settings.go b/cmd/workspace/apps-settings/apps-settings.go index 23a6438e20..664816e037 100755 --- a/cmd/workspace/apps-settings/apps-settings.go +++ b/cmd/workspace/apps-settings/apps-settings.go @@ -66,7 +66,7 @@ func newCreateCustomTemplate() *cobra.Command { cmd.Flags().Var(&createCustomTemplateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createCustomTemplateReq.Template.Description, "description", createCustomTemplateReq.Template.Description, `The description of the template.`) + cmd.Flags().StringVar(&createCustomTemplateReq.Template.Description, "description", createCustomTemplateReq.Template.Description, `The description of the template. Wire name: 'description'.`) cmd.Use = "create-custom-template NAME GIT_REPO PATH MANIFEST GIT_PROVIDER" cmd.Short = `Create a template.` @@ -280,8 +280,8 @@ func newListCustomTemplates() *cobra.Command { var listCustomTemplatesReq apps.ListCustomTemplatesRequest - cmd.Flags().IntVar(&listCustomTemplatesReq.PageSize, "page-size", listCustomTemplatesReq.PageSize, `Upper bound for items returned.`) - cmd.Flags().StringVar(&listCustomTemplatesReq.PageToken, "page-token", listCustomTemplatesReq.PageToken, `Pagination token to go to the next page of custom templates.`) + cmd.Flags().IntVar(&listCustomTemplatesReq.PageSize, "page-size", listCustomTemplatesReq.PageSize, `Upper bound for items returned. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listCustomTemplatesReq.PageToken, "page-token", listCustomTemplatesReq.PageToken, `Pagination token to go to the next page of custom templates. Wire name: 'page_token'.`) cmd.Use = "list-custom-templates" cmd.Short = `List templates.` @@ -335,7 +335,7 @@ func newUpdateCustomTemplate() *cobra.Command { cmd.Flags().Var(&updateCustomTemplateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateCustomTemplateReq.Template.Description, "description", updateCustomTemplateReq.Template.Description, `The description of the template.`) + cmd.Flags().StringVar(&updateCustomTemplateReq.Template.Description, "description", updateCustomTemplateReq.Template.Description, `The description of the template. Wire name: 'description'.`) cmd.Use = "update-custom-template NAME GIT_REPO PATH MANIFEST GIT_PROVIDER" cmd.Short = `Update a template.` diff --git a/cmd/workspace/apps/apps.go b/cmd/workspace/apps/apps.go index a3b18a0b08..f6c78eaa29 100755 --- a/cmd/workspace/apps/apps.go +++ b/cmd/workspace/apps/apps.go @@ -82,13 +82,13 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&createReq.NoCompute, "no-compute", createReq.NoCompute, `If true, the app will not be started after creation.`) + cmd.Flags().BoolVar(&createReq.NoCompute, "no-compute", createReq.NoCompute, `If true, the app will not be started after creation. Wire name: 'no_compute'.`) // TODO: complex arg: active_deployment // TODO: complex arg: app_status - cmd.Flags().StringVar(&createReq.App.BudgetPolicyId, "budget-policy-id", createReq.App.BudgetPolicyId, ``) - cmd.Flags().Var(&createReq.App.ComputeSize, "compute-size", `Supported values: [LARGE, LIQUID, MEDIUM]`) + cmd.Flags().StringVar(&createReq.App.BudgetPolicyId, "budget-policy-id", createReq.App.BudgetPolicyId, `Wire name: 'budget_policy_id'.`) + cmd.Flags().Var(&createReq.App.ComputeSize, "compute-size", `Supported values: [LARGE, LIQUID, MEDIUM]. Wire name: 'compute_size'.`) // TODO: complex arg: compute_status - cmd.Flags().StringVar(&createReq.App.Description, "description", createReq.App.Description, `The description of the app.`) + cmd.Flags().StringVar(&createReq.App.Description, "description", createReq.App.Description, `The description of the app. Wire name: 'description'.`) // TODO: array: effective_user_api_scopes // TODO: complex arg: pending_deployment // TODO: array: resources @@ -379,9 +379,9 @@ func newDeploy() *cobra.Command { cmd.Flags().Var(&deployJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: deployment_artifacts - cmd.Flags().StringVar(&deployReq.AppDeployment.DeploymentId, "deployment-id", deployReq.AppDeployment.DeploymentId, `The unique id of the deployment.`) - cmd.Flags().Var(&deployReq.AppDeployment.Mode, "mode", `The mode of which the deployment will manage the source code. Supported values: [AUTO_SYNC, SNAPSHOT]`) - cmd.Flags().StringVar(&deployReq.AppDeployment.SourceCodePath, "source-code-path", deployReq.AppDeployment.SourceCodePath, `The workspace file system path of the source code used to create the app deployment.`) + cmd.Flags().StringVar(&deployReq.AppDeployment.DeploymentId, "deployment-id", deployReq.AppDeployment.DeploymentId, `The unique id of the deployment. Wire name: 'deployment_id'.`) + cmd.Flags().Var(&deployReq.AppDeployment.Mode, "mode", `The mode of which the deployment will manage the source code. Supported values: [AUTO_SYNC, SNAPSHOT]. Wire name: 'mode'.`) + cmd.Flags().StringVar(&deployReq.AppDeployment.SourceCodePath, "source-code-path", deployReq.AppDeployment.SourceCodePath, `The workspace file system path of the source code used to create the app deployment. Wire name: 'source_code_path'.`) // TODO: complex arg: status cmd.Use = "deploy APP_NAME" @@ -755,8 +755,8 @@ func newList() *cobra.Command { var listReq apps.ListAppsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Upper bound for items returned.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Pagination token to go to the next page of apps.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Upper bound for items returned. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Pagination token to go to the next page of apps. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List apps.` @@ -806,8 +806,8 @@ func newListDeployments() *cobra.Command { var listDeploymentsReq apps.ListAppDeploymentsRequest - cmd.Flags().IntVar(&listDeploymentsReq.PageSize, "page-size", listDeploymentsReq.PageSize, `Upper bound for items returned.`) - cmd.Flags().StringVar(&listDeploymentsReq.PageToken, "page-token", listDeploymentsReq.PageToken, `Pagination token to go to the next page of apps.`) + cmd.Flags().IntVar(&listDeploymentsReq.PageSize, "page-size", listDeploymentsReq.PageSize, `Upper bound for items returned. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listDeploymentsReq.PageToken, "page-token", listDeploymentsReq.PageToken, `Pagination token to go to the next page of apps. Wire name: 'page_token'.`) cmd.Use = "list-deployments APP_NAME" cmd.Short = `List app deployments.` @@ -1105,10 +1105,10 @@ func newUpdate() *cobra.Command { // TODO: complex arg: active_deployment // TODO: complex arg: app_status - cmd.Flags().StringVar(&updateReq.App.BudgetPolicyId, "budget-policy-id", updateReq.App.BudgetPolicyId, ``) - cmd.Flags().Var(&updateReq.App.ComputeSize, "compute-size", `Supported values: [LARGE, LIQUID, MEDIUM]`) + cmd.Flags().StringVar(&updateReq.App.BudgetPolicyId, "budget-policy-id", updateReq.App.BudgetPolicyId, `Wire name: 'budget_policy_id'.`) + cmd.Flags().Var(&updateReq.App.ComputeSize, "compute-size", `Supported values: [LARGE, LIQUID, MEDIUM]. Wire name: 'compute_size'.`) // TODO: complex arg: compute_status - cmd.Flags().StringVar(&updateReq.App.Description, "description", updateReq.App.Description, `The description of the app.`) + cmd.Flags().StringVar(&updateReq.App.Description, "description", updateReq.App.Description, `The description of the app. Wire name: 'description'.`) // TODO: array: effective_user_api_scopes // TODO: complex arg: pending_deployment // TODO: array: resources diff --git a/cmd/workspace/automatic-cluster-update/automatic-cluster-update.go b/cmd/workspace/automatic-cluster-update/automatic-cluster-update.go index ad89283db6..39fb29a33c 100755 --- a/cmd/workspace/automatic-cluster-update/automatic-cluster-update.go +++ b/cmd/workspace/automatic-cluster-update/automatic-cluster-update.go @@ -52,7 +52,7 @@ func newGet() *cobra.Command { var getReq settings.GetAutomaticClusterUpdateSettingRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the automatic cluster update setting.` diff --git a/cmd/workspace/catalogs/catalogs.go b/cmd/workspace/catalogs/catalogs.go index 1beb5b2de8..16d2c620b4 100755 --- a/cmd/workspace/catalogs/catalogs.go +++ b/cmd/workspace/catalogs/catalogs.go @@ -68,13 +68,13 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `User-provided free-form text description.`) - cmd.Flags().StringVar(&createReq.ConnectionName, "connection-name", createReq.ConnectionName, `The name of the connection to an external data source.`) + cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `User-provided free-form text description. Wire name: 'comment'.`) + cmd.Flags().StringVar(&createReq.ConnectionName, "connection-name", createReq.ConnectionName, `The name of the connection to an external data source. Wire name: 'connection_name'.`) // TODO: map via StringToStringVar: options // TODO: map via StringToStringVar: properties - cmd.Flags().StringVar(&createReq.ProviderName, "provider-name", createReq.ProviderName, `The name of delta sharing provider.`) - cmd.Flags().StringVar(&createReq.ShareName, "share-name", createReq.ShareName, `The name of the share under the share provider.`) - cmd.Flags().StringVar(&createReq.StorageRoot, "storage-root", createReq.StorageRoot, `Storage root URL for managed tables within catalog.`) + cmd.Flags().StringVar(&createReq.ProviderName, "provider-name", createReq.ProviderName, `The name of delta sharing provider. Wire name: 'provider_name'.`) + cmd.Flags().StringVar(&createReq.ShareName, "share-name", createReq.ShareName, `The name of the share under the share provider. Wire name: 'share_name'.`) + cmd.Flags().StringVar(&createReq.StorageRoot, "storage-root", createReq.StorageRoot, `Storage root URL for managed tables within catalog. Wire name: 'storage_root'.`) cmd.Use = "create NAME" cmd.Short = `Create a catalog.` @@ -154,7 +154,7 @@ func newDelete() *cobra.Command { var deleteReq catalog.DeleteCatalogRequest - cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the catalog is not empty.`) + cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the catalog is not empty. Wire name: 'force'.`) cmd.Use = "delete NAME" cmd.Short = `Delete a catalog.` @@ -213,7 +213,7 @@ func newGet() *cobra.Command { var getReq catalog.GetCatalogRequest - cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include catalogs in the response for which the principal can only access selective metadata for.`) + cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include catalogs in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) cmd.Use = "get NAME" cmd.Short = `Get a catalog.` @@ -273,10 +273,10 @@ func newList() *cobra.Command { var listReq catalog.ListCatalogsRequest - cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include catalogs in the response for which the principal can only access selective metadata for.`) - cmd.Flags().BoolVar(&listReq.IncludeUnbound, "include-unbound", listReq.IncludeUnbound, `Whether to include catalogs not bound to the workspace.`) - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of catalogs to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include catalogs in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) + cmd.Flags().BoolVar(&listReq.IncludeUnbound, "include-unbound", listReq.IncludeUnbound, `Whether to include catalogs not bound to the workspace. Wire name: 'include_unbound'.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of catalogs to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List catalogs.` @@ -341,12 +341,12 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `User-provided free-form text description.`) - cmd.Flags().Var(&updateReq.EnablePredictiveOptimization, "enable-predictive-optimization", `Whether predictive optimization should be enabled for this object and objects under it. Supported values: [DISABLE, ENABLE, INHERIT]`) - cmd.Flags().Var(&updateReq.IsolationMode, "isolation-mode", `Whether the current securable is accessible from all workspaces or a specific set of workspaces. Supported values: [ISOLATED, OPEN]`) - cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the catalog.`) + cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `User-provided free-form text description. Wire name: 'comment'.`) + cmd.Flags().Var(&updateReq.EnablePredictiveOptimization, "enable-predictive-optimization", `Whether predictive optimization should be enabled for this object and objects under it. Supported values: [DISABLE, ENABLE, INHERIT]. Wire name: 'enable_predictive_optimization'.`) + cmd.Flags().Var(&updateReq.IsolationMode, "isolation-mode", `Whether the current securable is accessible from all workspaces or a specific set of workspaces. Supported values: [ISOLATED, OPEN]. Wire name: 'isolation_mode'.`) + cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the catalog. Wire name: 'new_name'.`) // TODO: map via StringToStringVar: options - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of catalog.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of catalog. Wire name: 'owner'.`) // TODO: map via StringToStringVar: properties cmd.Use = "update NAME" diff --git a/cmd/workspace/clean-room-asset-revisions/clean-room-asset-revisions.go b/cmd/workspace/clean-room-asset-revisions/clean-room-asset-revisions.go index 69094be382..2ab23fced4 100755 --- a/cmd/workspace/clean-room-asset-revisions/clean-room-asset-revisions.go +++ b/cmd/workspace/clean-room-asset-revisions/clean-room-asset-revisions.go @@ -123,8 +123,8 @@ func newList() *cobra.Command { var listReq cleanrooms.ListCleanRoomAssetRevisionsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Maximum number of asset revisions to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on the previous query.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Maximum number of asset revisions to return. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on the previous query. Wire name: 'page_token'.`) cmd.Use = "list CLEAN_ROOM_NAME ASSET_TYPE NAME" cmd.Short = `List asset revisions.` diff --git a/cmd/workspace/clean-room-assets/clean-room-assets.go b/cmd/workspace/clean-room-assets/clean-room-assets.go index 43a6af91ab..0e2df9ca56 100755 --- a/cmd/workspace/clean-room-assets/clean-room-assets.go +++ b/cmd/workspace/clean-room-assets/clean-room-assets.go @@ -64,7 +64,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Asset.CleanRoomName, "clean-room-name", createReq.Asset.CleanRoomName, `The name of the clean room this asset belongs to.`) + cmd.Flags().StringVar(&createReq.Asset.CleanRoomName, "clean-room-name", createReq.Asset.CleanRoomName, `The name of the clean room this asset belongs to. Wire name: 'clean_room_name'.`) // TODO: complex arg: foreign_table // TODO: complex arg: foreign_table_local_details // TODO: complex arg: notebook @@ -388,7 +388,7 @@ func newList() *cobra.Command { var listReq cleanrooms.ListCleanRoomAssetsRequest - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list CLEAN_ROOM_NAME" cmd.Short = `List assets.` @@ -445,7 +445,7 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Asset.CleanRoomName, "clean-room-name", updateReq.Asset.CleanRoomName, `The name of the clean room this asset belongs to.`) + cmd.Flags().StringVar(&updateReq.Asset.CleanRoomName, "clean-room-name", updateReq.Asset.CleanRoomName, `The name of the clean room this asset belongs to. Wire name: 'clean_room_name'.`) // TODO: complex arg: foreign_table // TODO: complex arg: foreign_table_local_details // TODO: complex arg: notebook diff --git a/cmd/workspace/clean-room-auto-approval-rules/clean-room-auto-approval-rules.go b/cmd/workspace/clean-room-auto-approval-rules/clean-room-auto-approval-rules.go index a88b3b0bde..afc528f8e5 100755 --- a/cmd/workspace/clean-room-auto-approval-rules/clean-room-auto-approval-rules.go +++ b/cmd/workspace/clean-room-auto-approval-rules/clean-room-auto-approval-rules.go @@ -241,8 +241,8 @@ func newList() *cobra.Command { var listReq cleanrooms.ListCleanRoomAutoApprovalRulesRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Maximum number of auto-approval rules to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Maximum number of auto-approval rules to return. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list CLEAN_ROOM_NAME" cmd.Short = `List auto-approval rules.` @@ -298,10 +298,10 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.AutoApprovalRule.AuthorCollaboratorAlias, "author-collaborator-alias", updateReq.AutoApprovalRule.AuthorCollaboratorAlias, `Collaborator alias of the author covered by the rule.`) - cmd.Flags().Var(&updateReq.AutoApprovalRule.AuthorScope, "author-scope", `Scope of authors covered by the rule. Supported values: [ANY_AUTHOR]`) - cmd.Flags().StringVar(&updateReq.AutoApprovalRule.CleanRoomName, "clean-room-name", updateReq.AutoApprovalRule.CleanRoomName, `The name of the clean room this auto-approval rule belongs to.`) - cmd.Flags().StringVar(&updateReq.AutoApprovalRule.RunnerCollaboratorAlias, "runner-collaborator-alias", updateReq.AutoApprovalRule.RunnerCollaboratorAlias, `Collaborator alias of the runner covered by the rule.`) + cmd.Flags().StringVar(&updateReq.AutoApprovalRule.AuthorCollaboratorAlias, "author-collaborator-alias", updateReq.AutoApprovalRule.AuthorCollaboratorAlias, `Collaborator alias of the author covered by the rule. Wire name: 'author_collaborator_alias'.`) + cmd.Flags().Var(&updateReq.AutoApprovalRule.AuthorScope, "author-scope", `Scope of authors covered by the rule. Supported values: [ANY_AUTHOR]. Wire name: 'author_scope'.`) + cmd.Flags().StringVar(&updateReq.AutoApprovalRule.CleanRoomName, "clean-room-name", updateReq.AutoApprovalRule.CleanRoomName, `The name of the clean room this auto-approval rule belongs to. Wire name: 'clean_room_name'.`) + cmd.Flags().StringVar(&updateReq.AutoApprovalRule.RunnerCollaboratorAlias, "runner-collaborator-alias", updateReq.AutoApprovalRule.RunnerCollaboratorAlias, `Collaborator alias of the runner covered by the rule. Wire name: 'runner_collaborator_alias'.`) cmd.Use = "update CLEAN_ROOM_NAME RULE_ID" cmd.Short = `Update an auto-approval rule.` diff --git a/cmd/workspace/clean-room-task-runs/clean-room-task-runs.go b/cmd/workspace/clean-room-task-runs/clean-room-task-runs.go index f4817fb7f8..ecf1f2deef 100755 --- a/cmd/workspace/clean-room-task-runs/clean-room-task-runs.go +++ b/cmd/workspace/clean-room-task-runs/clean-room-task-runs.go @@ -51,9 +51,9 @@ func newList() *cobra.Command { var listReq cleanrooms.ListCleanRoomNotebookTaskRunsRequest - cmd.Flags().StringVar(&listReq.NotebookName, "notebook-name", listReq.NotebookName, `Notebook name.`) - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `The maximum number of task runs to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().StringVar(&listReq.NotebookName, "notebook-name", listReq.NotebookName, `Notebook name. Wire name: 'notebook_name'.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `The maximum number of task runs to return. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list CLEAN_ROOM_NAME" cmd.Short = `List notebook task runs.` diff --git a/cmd/workspace/clean-rooms/clean-rooms.go b/cmd/workspace/clean-rooms/clean-rooms.go index 4b94810aa7..953af4204b 100755 --- a/cmd/workspace/clean-rooms/clean-rooms.go +++ b/cmd/workspace/clean-rooms/clean-rooms.go @@ -72,10 +72,10 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.CleanRoom.Comment, "comment", createReq.CleanRoom.Comment, ``) - cmd.Flags().StringVar(&createReq.CleanRoom.Name, "name", createReq.CleanRoom.Name, `The name of the clean room.`) + cmd.Flags().StringVar(&createReq.CleanRoom.Comment, "comment", createReq.CleanRoom.Comment, `Wire name: 'comment'.`) + cmd.Flags().StringVar(&createReq.CleanRoom.Name, "name", createReq.CleanRoom.Name, `The name of the clean room. Wire name: 'name'.`) // TODO: complex arg: output_catalog - cmd.Flags().StringVar(&createReq.CleanRoom.Owner, "owner", createReq.CleanRoom.Owner, `This is the Databricks username of the owner of the local clean room securable for permission management.`) + cmd.Flags().StringVar(&createReq.CleanRoom.Owner, "owner", createReq.CleanRoom.Owner, `This is the Databricks username of the owner of the local clean room securable for permission management. Wire name: 'owner'.`) // TODO: complex arg: remote_detailed_info cmd.Use = "create" @@ -167,7 +167,7 @@ func newCreateOutputCatalog() *cobra.Command { cmd.Flags().Var(&createOutputCatalogJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createOutputCatalogReq.OutputCatalog.CatalogName, "catalog-name", createOutputCatalogReq.OutputCatalog.CatalogName, `The name of the output catalog in UC.`) + cmd.Flags().StringVar(&createOutputCatalogReq.OutputCatalog.CatalogName, "catalog-name", createOutputCatalogReq.OutputCatalog.CatalogName, `The name of the output catalog in UC. Wire name: 'catalog_name'.`) cmd.Use = "create-output-catalog CLEAN_ROOM_NAME" cmd.Short = `Create an output catalog.` @@ -349,8 +349,8 @@ func newList() *cobra.Command { var listReq cleanrooms.ListCleanRoomsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Maximum number of clean rooms to return (i.e., the page length).`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Maximum number of clean rooms to return (i.e., the page length). Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List clean rooms.` diff --git a/cmd/workspace/cluster-policies/cluster-policies.go b/cmd/workspace/cluster-policies/cluster-policies.go index 5423ec37c4..8fe3585cee 100755 --- a/cmd/workspace/cluster-policies/cluster-policies.go +++ b/cmd/workspace/cluster-policies/cluster-policies.go @@ -87,13 +87,13 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Definition, "definition", createReq.Definition, `Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).`) - cmd.Flags().StringVar(&createReq.Description, "description", createReq.Description, `Additional human-readable description of the cluster policy.`) + cmd.Flags().StringVar(&createReq.Definition, "definition", createReq.Definition, `Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html). Wire name: 'definition'.`) + cmd.Flags().StringVar(&createReq.Description, "description", createReq.Description, `Additional human-readable description of the cluster policy. Wire name: 'description'.`) // TODO: array: libraries - cmd.Flags().Int64Var(&createReq.MaxClustersPerUser, "max-clusters-per-user", createReq.MaxClustersPerUser, `Max number of clusters per user that can be active using this policy.`) - cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `Cluster Policy name requested by the user.`) - cmd.Flags().StringVar(&createReq.PolicyFamilyDefinitionOverrides, "policy-family-definition-overrides", createReq.PolicyFamilyDefinitionOverrides, `Policy definition JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).`) - cmd.Flags().StringVar(&createReq.PolicyFamilyId, "policy-family-id", createReq.PolicyFamilyId, `ID of the policy family.`) + cmd.Flags().Int64Var(&createReq.MaxClustersPerUser, "max-clusters-per-user", createReq.MaxClustersPerUser, `Max number of clusters per user that can be active using this policy. Wire name: 'max_clusters_per_user'.`) + cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `Cluster Policy name requested by the user. Wire name: 'name'.`) + cmd.Flags().StringVar(&createReq.PolicyFamilyDefinitionOverrides, "policy-family-definition-overrides", createReq.PolicyFamilyDefinitionOverrides, `Policy definition JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html). Wire name: 'policy_family_definition_overrides'.`) + cmd.Flags().StringVar(&createReq.PolicyFamilyId, "policy-family-id", createReq.PolicyFamilyId, `ID of the policy family. Wire name: 'policy_family_id'.`) cmd.Use = "create" cmd.Short = `Create a new policy.` @@ -258,13 +258,13 @@ func newEdit() *cobra.Command { cmd.Flags().Var(&editJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&editReq.Definition, "definition", editReq.Definition, `Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).`) - cmd.Flags().StringVar(&editReq.Description, "description", editReq.Description, `Additional human-readable description of the cluster policy.`) + cmd.Flags().StringVar(&editReq.Definition, "definition", editReq.Definition, `Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html). Wire name: 'definition'.`) + cmd.Flags().StringVar(&editReq.Description, "description", editReq.Description, `Additional human-readable description of the cluster policy. Wire name: 'description'.`) // TODO: array: libraries - cmd.Flags().Int64Var(&editReq.MaxClustersPerUser, "max-clusters-per-user", editReq.MaxClustersPerUser, `Max number of clusters per user that can be active using this policy.`) - cmd.Flags().StringVar(&editReq.Name, "name", editReq.Name, `Cluster Policy name requested by the user.`) - cmd.Flags().StringVar(&editReq.PolicyFamilyDefinitionOverrides, "policy-family-definition-overrides", editReq.PolicyFamilyDefinitionOverrides, `Policy definition JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).`) - cmd.Flags().StringVar(&editReq.PolicyFamilyId, "policy-family-id", editReq.PolicyFamilyId, `ID of the policy family.`) + cmd.Flags().Int64Var(&editReq.MaxClustersPerUser, "max-clusters-per-user", editReq.MaxClustersPerUser, `Max number of clusters per user that can be active using this policy. Wire name: 'max_clusters_per_user'.`) + cmd.Flags().StringVar(&editReq.Name, "name", editReq.Name, `Cluster Policy name requested by the user. Wire name: 'name'.`) + cmd.Flags().StringVar(&editReq.PolicyFamilyDefinitionOverrides, "policy-family-definition-overrides", editReq.PolicyFamilyDefinitionOverrides, `Policy definition JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html). Wire name: 'policy_family_definition_overrides'.`) + cmd.Flags().StringVar(&editReq.PolicyFamilyId, "policy-family-id", editReq.PolicyFamilyId, `ID of the policy family. Wire name: 'policy_family_id'.`) cmd.Use = "edit POLICY_ID" cmd.Short = `Update a cluster policy.` @@ -565,8 +565,8 @@ func newList() *cobra.Command { var listReq compute.ListClusterPoliciesRequest - cmd.Flags().Var(&listReq.SortColumn, "sort-column", `The cluster policy attribute to sort by. Supported values: [POLICY_CREATION_TIME, POLICY_NAME]`) - cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order in which the policies get listed. Supported values: [ASC, DESC]`) + cmd.Flags().Var(&listReq.SortColumn, "sort-column", `The cluster policy attribute to sort by. Supported values: [POLICY_CREATION_TIME, POLICY_NAME]. Wire name: 'sort_column'.`) + cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order in which the policies get listed. Supported values: [ASC, DESC]. Wire name: 'sort_order'.`) cmd.Use = "list" cmd.Short = `List cluster policies.` diff --git a/cmd/workspace/clusters/clusters.go b/cmd/workspace/clusters/clusters.go index 9d99e81062..3228b3085f 100755 --- a/cmd/workspace/clusters/clusters.go +++ b/cmd/workspace/clusters/clusters.go @@ -195,14 +195,14 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&createReq.ApplyPolicyDefaultValues, "apply-policy-default-values", createReq.ApplyPolicyDefaultValues, `When set to true, fixed and default values from the policy will be used for fields that are omitted.`) + cmd.Flags().BoolVar(&createReq.ApplyPolicyDefaultValues, "apply-policy-default-values", createReq.ApplyPolicyDefaultValues, `When set to true, fixed and default values from the policy will be used for fields that are omitted. Wire name: 'apply_policy_default_values'.`) // TODO: complex arg: autoscale - cmd.Flags().IntVar(&createReq.AutoterminationMinutes, "autotermination-minutes", createReq.AutoterminationMinutes, `Automatically terminates the cluster after it is inactive for this time in minutes.`) + cmd.Flags().IntVar(&createReq.AutoterminationMinutes, "autotermination-minutes", createReq.AutoterminationMinutes, `Automatically terminates the cluster after it is inactive for this time in minutes. Wire name: 'autotermination_minutes'.`) // TODO: complex arg: aws_attributes // TODO: complex arg: azure_attributes // TODO: complex arg: clone_from // TODO: complex arg: cluster_log_conf - cmd.Flags().StringVar(&createReq.ClusterName, "cluster-name", createReq.ClusterName, `Cluster name requested by the user.`) + cmd.Flags().StringVar(&createReq.ClusterName, "cluster-name", createReq.ClusterName, `Cluster name requested by the user. Wire name: 'cluster_name'.`) // TODO: map via StringToStringVar: custom_tags cmd.Flags().Var(&createReq.DataSecurityMode, "data-security-mode", `Supported values: [ DATA_SECURITY_MODE_AUTO, @@ -215,28 +215,28 @@ func newCreate() *cobra.Command { NONE, SINGLE_USER, USER_ISOLATION, -]`) +]. Wire name: 'data_security_mode'.`) // TODO: complex arg: docker_image - cmd.Flags().StringVar(&createReq.DriverInstancePoolId, "driver-instance-pool-id", createReq.DriverInstancePoolId, `The optional ID of the instance pool for the driver of the cluster belongs.`) - cmd.Flags().StringVar(&createReq.DriverNodeTypeId, "driver-node-type-id", createReq.DriverNodeTypeId, `The node type of the Spark driver.`) - cmd.Flags().BoolVar(&createReq.EnableElasticDisk, "enable-elastic-disk", createReq.EnableElasticDisk, `Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk space when its Spark workers are running low on disk space.`) - cmd.Flags().BoolVar(&createReq.EnableLocalDiskEncryption, "enable-local-disk-encryption", createReq.EnableLocalDiskEncryption, `Whether to enable LUKS on cluster VMs' local disks.`) + cmd.Flags().StringVar(&createReq.DriverInstancePoolId, "driver-instance-pool-id", createReq.DriverInstancePoolId, `The optional ID of the instance pool for the driver of the cluster belongs. Wire name: 'driver_instance_pool_id'.`) + cmd.Flags().StringVar(&createReq.DriverNodeTypeId, "driver-node-type-id", createReq.DriverNodeTypeId, `The node type of the Spark driver. Wire name: 'driver_node_type_id'.`) + cmd.Flags().BoolVar(&createReq.EnableElasticDisk, "enable-elastic-disk", createReq.EnableElasticDisk, `Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk space when its Spark workers are running low on disk space. Wire name: 'enable_elastic_disk'.`) + cmd.Flags().BoolVar(&createReq.EnableLocalDiskEncryption, "enable-local-disk-encryption", createReq.EnableLocalDiskEncryption, `Whether to enable LUKS on cluster VMs' local disks. Wire name: 'enable_local_disk_encryption'.`) // TODO: complex arg: gcp_attributes // TODO: array: init_scripts - cmd.Flags().StringVar(&createReq.InstancePoolId, "instance-pool-id", createReq.InstancePoolId, `The optional ID of the instance pool to which the cluster belongs.`) - cmd.Flags().BoolVar(&createReq.IsSingleNode, "is-single-node", createReq.IsSingleNode, `This field can only be used when kind = CLASSIC_PREVIEW.`) - cmd.Flags().Var(&createReq.Kind, "kind", `Supported values: [CLASSIC_PREVIEW]`) - cmd.Flags().StringVar(&createReq.NodeTypeId, "node-type-id", createReq.NodeTypeId, `This field encodes, through a single value, the resources available to each of the Spark nodes in this cluster.`) - cmd.Flags().IntVar(&createReq.NumWorkers, "num-workers", createReq.NumWorkers, `Number of worker nodes that this cluster should have.`) - cmd.Flags().StringVar(&createReq.PolicyId, "policy-id", createReq.PolicyId, `The ID of the cluster policy used to create the cluster if applicable.`) - cmd.Flags().IntVar(&createReq.RemoteDiskThroughput, "remote-disk-throughput", createReq.RemoteDiskThroughput, `If set, what the configurable throughput (in Mb/s) for the remote disk is.`) - cmd.Flags().Var(&createReq.RuntimeEngine, "runtime-engine", `Determines the cluster's runtime engine, either standard or Photon. Supported values: [NULL, PHOTON, STANDARD]`) - cmd.Flags().StringVar(&createReq.SingleUserName, "single-user-name", createReq.SingleUserName, `Single user name if data_security_mode is SINGLE_USER.`) + cmd.Flags().StringVar(&createReq.InstancePoolId, "instance-pool-id", createReq.InstancePoolId, `The optional ID of the instance pool to which the cluster belongs. Wire name: 'instance_pool_id'.`) + cmd.Flags().BoolVar(&createReq.IsSingleNode, "is-single-node", createReq.IsSingleNode, `This field can only be used when kind = CLASSIC_PREVIEW. Wire name: 'is_single_node'.`) + cmd.Flags().Var(&createReq.Kind, "kind", `Supported values: [CLASSIC_PREVIEW]. Wire name: 'kind'.`) + cmd.Flags().StringVar(&createReq.NodeTypeId, "node-type-id", createReq.NodeTypeId, `This field encodes, through a single value, the resources available to each of the Spark nodes in this cluster. Wire name: 'node_type_id'.`) + cmd.Flags().IntVar(&createReq.NumWorkers, "num-workers", createReq.NumWorkers, `Number of worker nodes that this cluster should have. Wire name: 'num_workers'.`) + cmd.Flags().StringVar(&createReq.PolicyId, "policy-id", createReq.PolicyId, `The ID of the cluster policy used to create the cluster if applicable. Wire name: 'policy_id'.`) + cmd.Flags().IntVar(&createReq.RemoteDiskThroughput, "remote-disk-throughput", createReq.RemoteDiskThroughput, `If set, what the configurable throughput (in Mb/s) for the remote disk is. Wire name: 'remote_disk_throughput'.`) + cmd.Flags().Var(&createReq.RuntimeEngine, "runtime-engine", `Determines the cluster's runtime engine, either standard or Photon. Supported values: [NULL, PHOTON, STANDARD]. Wire name: 'runtime_engine'.`) + cmd.Flags().StringVar(&createReq.SingleUserName, "single-user-name", createReq.SingleUserName, `Single user name if data_security_mode is SINGLE_USER. Wire name: 'single_user_name'.`) // TODO: map via StringToStringVar: spark_conf // TODO: map via StringToStringVar: spark_env_vars // TODO: array: ssh_public_keys - cmd.Flags().IntVar(&createReq.TotalInitialRemoteDiskSize, "total-initial-remote-disk-size", createReq.TotalInitialRemoteDiskSize, `If set, what the total initial volume size (in GB) of the remote disks should be.`) - cmd.Flags().BoolVar(&createReq.UseMlRuntime, "use-ml-runtime", createReq.UseMlRuntime, `This field can only be used when kind = CLASSIC_PREVIEW.`) + cmd.Flags().IntVar(&createReq.TotalInitialRemoteDiskSize, "total-initial-remote-disk-size", createReq.TotalInitialRemoteDiskSize, `If set, what the total initial volume size (in GB) of the remote disks should be. Wire name: 'total_initial_remote_disk_size'.`) + cmd.Flags().BoolVar(&createReq.UseMlRuntime, "use-ml-runtime", createReq.UseMlRuntime, `This field can only be used when kind = CLASSIC_PREVIEW. Wire name: 'use_ml_runtime'.`) // TODO: complex arg: workload_type cmd.Use = "create SPARK_VERSION" @@ -471,13 +471,13 @@ func newEdit() *cobra.Command { cmd.Flags().Var(&editJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&editReq.ApplyPolicyDefaultValues, "apply-policy-default-values", editReq.ApplyPolicyDefaultValues, `When set to true, fixed and default values from the policy will be used for fields that are omitted.`) + cmd.Flags().BoolVar(&editReq.ApplyPolicyDefaultValues, "apply-policy-default-values", editReq.ApplyPolicyDefaultValues, `When set to true, fixed and default values from the policy will be used for fields that are omitted. Wire name: 'apply_policy_default_values'.`) // TODO: complex arg: autoscale - cmd.Flags().IntVar(&editReq.AutoterminationMinutes, "autotermination-minutes", editReq.AutoterminationMinutes, `Automatically terminates the cluster after it is inactive for this time in minutes.`) + cmd.Flags().IntVar(&editReq.AutoterminationMinutes, "autotermination-minutes", editReq.AutoterminationMinutes, `Automatically terminates the cluster after it is inactive for this time in minutes. Wire name: 'autotermination_minutes'.`) // TODO: complex arg: aws_attributes // TODO: complex arg: azure_attributes // TODO: complex arg: cluster_log_conf - cmd.Flags().StringVar(&editReq.ClusterName, "cluster-name", editReq.ClusterName, `Cluster name requested by the user.`) + cmd.Flags().StringVar(&editReq.ClusterName, "cluster-name", editReq.ClusterName, `Cluster name requested by the user. Wire name: 'cluster_name'.`) // TODO: map via StringToStringVar: custom_tags cmd.Flags().Var(&editReq.DataSecurityMode, "data-security-mode", `Supported values: [ DATA_SECURITY_MODE_AUTO, @@ -490,28 +490,28 @@ func newEdit() *cobra.Command { NONE, SINGLE_USER, USER_ISOLATION, -]`) +]. Wire name: 'data_security_mode'.`) // TODO: complex arg: docker_image - cmd.Flags().StringVar(&editReq.DriverInstancePoolId, "driver-instance-pool-id", editReq.DriverInstancePoolId, `The optional ID of the instance pool for the driver of the cluster belongs.`) - cmd.Flags().StringVar(&editReq.DriverNodeTypeId, "driver-node-type-id", editReq.DriverNodeTypeId, `The node type of the Spark driver.`) - cmd.Flags().BoolVar(&editReq.EnableElasticDisk, "enable-elastic-disk", editReq.EnableElasticDisk, `Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk space when its Spark workers are running low on disk space.`) - cmd.Flags().BoolVar(&editReq.EnableLocalDiskEncryption, "enable-local-disk-encryption", editReq.EnableLocalDiskEncryption, `Whether to enable LUKS on cluster VMs' local disks.`) + cmd.Flags().StringVar(&editReq.DriverInstancePoolId, "driver-instance-pool-id", editReq.DriverInstancePoolId, `The optional ID of the instance pool for the driver of the cluster belongs. Wire name: 'driver_instance_pool_id'.`) + cmd.Flags().StringVar(&editReq.DriverNodeTypeId, "driver-node-type-id", editReq.DriverNodeTypeId, `The node type of the Spark driver. Wire name: 'driver_node_type_id'.`) + cmd.Flags().BoolVar(&editReq.EnableElasticDisk, "enable-elastic-disk", editReq.EnableElasticDisk, `Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk space when its Spark workers are running low on disk space. Wire name: 'enable_elastic_disk'.`) + cmd.Flags().BoolVar(&editReq.EnableLocalDiskEncryption, "enable-local-disk-encryption", editReq.EnableLocalDiskEncryption, `Whether to enable LUKS on cluster VMs' local disks. Wire name: 'enable_local_disk_encryption'.`) // TODO: complex arg: gcp_attributes // TODO: array: init_scripts - cmd.Flags().StringVar(&editReq.InstancePoolId, "instance-pool-id", editReq.InstancePoolId, `The optional ID of the instance pool to which the cluster belongs.`) - cmd.Flags().BoolVar(&editReq.IsSingleNode, "is-single-node", editReq.IsSingleNode, `This field can only be used when kind = CLASSIC_PREVIEW.`) - cmd.Flags().Var(&editReq.Kind, "kind", `Supported values: [CLASSIC_PREVIEW]`) - cmd.Flags().StringVar(&editReq.NodeTypeId, "node-type-id", editReq.NodeTypeId, `This field encodes, through a single value, the resources available to each of the Spark nodes in this cluster.`) - cmd.Flags().IntVar(&editReq.NumWorkers, "num-workers", editReq.NumWorkers, `Number of worker nodes that this cluster should have.`) - cmd.Flags().StringVar(&editReq.PolicyId, "policy-id", editReq.PolicyId, `The ID of the cluster policy used to create the cluster if applicable.`) - cmd.Flags().IntVar(&editReq.RemoteDiskThroughput, "remote-disk-throughput", editReq.RemoteDiskThroughput, `If set, what the configurable throughput (in Mb/s) for the remote disk is.`) - cmd.Flags().Var(&editReq.RuntimeEngine, "runtime-engine", `Determines the cluster's runtime engine, either standard or Photon. Supported values: [NULL, PHOTON, STANDARD]`) - cmd.Flags().StringVar(&editReq.SingleUserName, "single-user-name", editReq.SingleUserName, `Single user name if data_security_mode is SINGLE_USER.`) + cmd.Flags().StringVar(&editReq.InstancePoolId, "instance-pool-id", editReq.InstancePoolId, `The optional ID of the instance pool to which the cluster belongs. Wire name: 'instance_pool_id'.`) + cmd.Flags().BoolVar(&editReq.IsSingleNode, "is-single-node", editReq.IsSingleNode, `This field can only be used when kind = CLASSIC_PREVIEW. Wire name: 'is_single_node'.`) + cmd.Flags().Var(&editReq.Kind, "kind", `Supported values: [CLASSIC_PREVIEW]. Wire name: 'kind'.`) + cmd.Flags().StringVar(&editReq.NodeTypeId, "node-type-id", editReq.NodeTypeId, `This field encodes, through a single value, the resources available to each of the Spark nodes in this cluster. Wire name: 'node_type_id'.`) + cmd.Flags().IntVar(&editReq.NumWorkers, "num-workers", editReq.NumWorkers, `Number of worker nodes that this cluster should have. Wire name: 'num_workers'.`) + cmd.Flags().StringVar(&editReq.PolicyId, "policy-id", editReq.PolicyId, `The ID of the cluster policy used to create the cluster if applicable. Wire name: 'policy_id'.`) + cmd.Flags().IntVar(&editReq.RemoteDiskThroughput, "remote-disk-throughput", editReq.RemoteDiskThroughput, `If set, what the configurable throughput (in Mb/s) for the remote disk is. Wire name: 'remote_disk_throughput'.`) + cmd.Flags().Var(&editReq.RuntimeEngine, "runtime-engine", `Determines the cluster's runtime engine, either standard or Photon. Supported values: [NULL, PHOTON, STANDARD]. Wire name: 'runtime_engine'.`) + cmd.Flags().StringVar(&editReq.SingleUserName, "single-user-name", editReq.SingleUserName, `Single user name if data_security_mode is SINGLE_USER. Wire name: 'single_user_name'.`) // TODO: map via StringToStringVar: spark_conf // TODO: map via StringToStringVar: spark_env_vars // TODO: array: ssh_public_keys - cmd.Flags().IntVar(&editReq.TotalInitialRemoteDiskSize, "total-initial-remote-disk-size", editReq.TotalInitialRemoteDiskSize, `If set, what the total initial volume size (in GB) of the remote disks should be.`) - cmd.Flags().BoolVar(&editReq.UseMlRuntime, "use-ml-runtime", editReq.UseMlRuntime, `This field can only be used when kind = CLASSIC_PREVIEW.`) + cmd.Flags().IntVar(&editReq.TotalInitialRemoteDiskSize, "total-initial-remote-disk-size", editReq.TotalInitialRemoteDiskSize, `If set, what the total initial volume size (in GB) of the remote disks should be. Wire name: 'total_initial_remote_disk_size'.`) + cmd.Flags().BoolVar(&editReq.UseMlRuntime, "use-ml-runtime", editReq.UseMlRuntime, `This field can only be used when kind = CLASSIC_PREVIEW. Wire name: 'use_ml_runtime'.`) // TODO: complex arg: workload_type cmd.Use = "edit CLUSTER_ID SPARK_VERSION" @@ -623,14 +623,14 @@ func newEvents() *cobra.Command { cmd.Flags().Var(&eventsJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().Int64Var(&eventsReq.EndTime, "end-time", eventsReq.EndTime, `The end time in epoch milliseconds.`) + cmd.Flags().Int64Var(&eventsReq.EndTime, "end-time", eventsReq.EndTime, `The end time in epoch milliseconds. Wire name: 'end_time'.`) // TODO: array: event_types - cmd.Flags().Int64Var(&eventsReq.Limit, "limit", eventsReq.Limit, `Deprecated: use page_token in combination with page_size instead.`) - cmd.Flags().Int64Var(&eventsReq.Offset, "offset", eventsReq.Offset, `Deprecated: use page_token in combination with page_size instead.`) - cmd.Flags().Var(&eventsReq.Order, "order", `The order to list events in; either "ASC" or "DESC". Supported values: [ASC, DESC]`) - cmd.Flags().IntVar(&eventsReq.PageSize, "page-size", eventsReq.PageSize, `The maximum number of events to include in a page of events.`) - cmd.Flags().StringVar(&eventsReq.PageToken, "page-token", eventsReq.PageToken, `Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of events respectively.`) - cmd.Flags().Int64Var(&eventsReq.StartTime, "start-time", eventsReq.StartTime, `The start time in epoch milliseconds.`) + cmd.Flags().Int64Var(&eventsReq.Limit, "limit", eventsReq.Limit, `Deprecated: use page_token in combination with page_size instead. Wire name: 'limit'.`) + cmd.Flags().Int64Var(&eventsReq.Offset, "offset", eventsReq.Offset, `Deprecated: use page_token in combination with page_size instead. Wire name: 'offset'.`) + cmd.Flags().Var(&eventsReq.Order, "order", `The order to list events in; either "ASC" or "DESC". Supported values: [ASC, DESC]. Wire name: 'order'.`) + cmd.Flags().IntVar(&eventsReq.PageSize, "page-size", eventsReq.PageSize, `The maximum number of events to include in a page of events. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&eventsReq.PageToken, "page-token", eventsReq.PageToken, `Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of events respectively. Wire name: 'page_token'.`) + cmd.Flags().Int64Var(&eventsReq.StartTime, "start-time", eventsReq.StartTime, `The start time in epoch milliseconds. Wire name: 'start_time'.`) cmd.Use = "events CLUSTER_ID" cmd.Short = `List cluster activity events.` @@ -931,8 +931,8 @@ func newList() *cobra.Command { var listReq compute.ListClustersRequest // TODO: complex arg: filter_by - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Use this field to specify the maximum number of results to be returned by the server.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of clusters respectively.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Use this field to specify the maximum number of results to be returned by the server. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of clusters respectively. Wire name: 'page_token'.`) // TODO: complex arg: sort_by cmd.Use = "list" @@ -1275,7 +1275,7 @@ func newResize() *cobra.Command { cmd.Flags().Var(&resizeJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: autoscale - cmd.Flags().IntVar(&resizeReq.NumWorkers, "num-workers", resizeReq.NumWorkers, `Number of worker nodes that this cluster should have.`) + cmd.Flags().IntVar(&resizeReq.NumWorkers, "num-workers", resizeReq.NumWorkers, `Number of worker nodes that this cluster should have. Wire name: 'num_workers'.`) cmd.Use = "resize CLUSTER_ID" cmd.Short = `Resize cluster.` @@ -1392,7 +1392,7 @@ func newRestart() *cobra.Command { cmd.Flags().Var(&restartJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&restartReq.RestartUser, "restart-user", restartReq.RestartUser, ``) + cmd.Flags().StringVar(&restartReq.RestartUser, "restart-user", restartReq.RestartUser, `Wire name: 'restart_user'.`) cmd.Use = "restart CLUSTER_ID" cmd.Short = `Restart cluster.` diff --git a/cmd/workspace/compliance-security-profile/compliance-security-profile.go b/cmd/workspace/compliance-security-profile/compliance-security-profile.go index 5841dd4e71..56fb6144c1 100755 --- a/cmd/workspace/compliance-security-profile/compliance-security-profile.go +++ b/cmd/workspace/compliance-security-profile/compliance-security-profile.go @@ -55,7 +55,7 @@ func newGet() *cobra.Command { var getReq settings.GetComplianceSecurityProfileSettingRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the compliance security profile setting.` diff --git a/cmd/workspace/connections/connections.go b/cmd/workspace/connections/connections.go index 7698c5d9e9..8ef5b1bea7 100755 --- a/cmd/workspace/connections/connections.go +++ b/cmd/workspace/connections/connections.go @@ -71,9 +71,9 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `User-provided free-form text description.`) + cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `User-provided free-form text description. Wire name: 'comment'.`) // TODO: map via StringToStringVar: properties - cmd.Flags().BoolVar(&createReq.ReadOnly, "read-only", createReq.ReadOnly, `If the connection is read only.`) + cmd.Flags().BoolVar(&createReq.ReadOnly, "read-only", createReq.ReadOnly, `If the connection is read only. Wire name: 'read_only'.`) cmd.Use = "create" cmd.Short = `Create a connection.` @@ -276,8 +276,8 @@ func newList() *cobra.Command { var listReq catalog.ListConnectionsRequest - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of connections to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of connections to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List connections.` @@ -338,8 +338,8 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the connection.`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of the connection.`) + cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the connection. Wire name: 'new_name'.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of the connection. Wire name: 'owner'.`) cmd.Use = "update NAME" cmd.Short = `Update a connection.` diff --git a/cmd/workspace/consumer-fulfillments/consumer-fulfillments.go b/cmd/workspace/consumer-fulfillments/consumer-fulfillments.go index 62f6e0be6f..e8355987e7 100755 --- a/cmd/workspace/consumer-fulfillments/consumer-fulfillments.go +++ b/cmd/workspace/consumer-fulfillments/consumer-fulfillments.go @@ -52,8 +52,8 @@ func newGet() *cobra.Command { var getReq marketplace.GetListingContentMetadataRequest - cmd.Flags().IntVar(&getReq.PageSize, "page-size", getReq.PageSize, ``) - cmd.Flags().StringVar(&getReq.PageToken, "page-token", getReq.PageToken, ``) + cmd.Flags().IntVar(&getReq.PageSize, "page-size", getReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&getReq.PageToken, "page-token", getReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "get LISTING_ID" cmd.Short = `Get listing content metadata.` @@ -105,8 +105,8 @@ func newList() *cobra.Command { var listReq marketplace.ListFulfillmentsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list LISTING_ID" cmd.Short = `List all listing fulfillments.` diff --git a/cmd/workspace/consumer-installations/consumer-installations.go b/cmd/workspace/consumer-installations/consumer-installations.go index a686ad2ce9..9a8bae14a6 100755 --- a/cmd/workspace/consumer-installations/consumer-installations.go +++ b/cmd/workspace/consumer-installations/consumer-installations.go @@ -63,10 +63,10 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: accepted_consumer_terms - cmd.Flags().StringVar(&createReq.CatalogName, "catalog-name", createReq.CatalogName, ``) - cmd.Flags().Var(&createReq.RecipientType, "recipient-type", `Supported values: [DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS, DELTA_SHARING_RECIPIENT_TYPE_OPEN]`) + cmd.Flags().StringVar(&createReq.CatalogName, "catalog-name", createReq.CatalogName, `Wire name: 'catalog_name'.`) + cmd.Flags().Var(&createReq.RecipientType, "recipient-type", `Supported values: [DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS, DELTA_SHARING_RECIPIENT_TYPE_OPEN]. Wire name: 'recipient_type'.`) // TODO: complex arg: repo_detail - cmd.Flags().StringVar(&createReq.ShareName, "share-name", createReq.ShareName, ``) + cmd.Flags().StringVar(&createReq.ShareName, "share-name", createReq.ShareName, `Wire name: 'share_name'.`) cmd.Use = "create LISTING_ID" cmd.Short = `Install from a listing.` @@ -187,8 +187,8 @@ func newList() *cobra.Command { var listReq marketplace.ListAllInstallationsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List all installations.` @@ -238,8 +238,8 @@ func newListListingInstallations() *cobra.Command { var listListingInstallationsReq marketplace.ListInstallationsRequest - cmd.Flags().IntVar(&listListingInstallationsReq.PageSize, "page-size", listListingInstallationsReq.PageSize, ``) - cmd.Flags().StringVar(&listListingInstallationsReq.PageToken, "page-token", listListingInstallationsReq.PageToken, ``) + cmd.Flags().IntVar(&listListingInstallationsReq.PageSize, "page-size", listListingInstallationsReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listListingInstallationsReq.PageToken, "page-token", listListingInstallationsReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list-listing-installations LISTING_ID" cmd.Short = `List installations for a listing.` @@ -294,7 +294,7 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&updateReq.RotateToken, "rotate-token", updateReq.RotateToken, ``) + cmd.Flags().BoolVar(&updateReq.RotateToken, "rotate-token", updateReq.RotateToken, `Wire name: 'rotate_token'.`) cmd.Use = "update LISTING_ID INSTALLATION_ID" cmd.Short = `Update an installation.` diff --git a/cmd/workspace/consumer-listings/consumer-listings.go b/cmd/workspace/consumer-listings/consumer-listings.go index a73fac1267..18cdbca9c8 100755 --- a/cmd/workspace/consumer-listings/consumer-listings.go +++ b/cmd/workspace/consumer-listings/consumer-listings.go @@ -179,11 +179,11 @@ func newList() *cobra.Command { // TODO: array: assets // TODO: array: categories - cmd.Flags().BoolVar(&listReq.IsFree, "is-free", listReq.IsFree, `Filters each listing based on if it is free.`) - cmd.Flags().BoolVar(&listReq.IsPrivateExchange, "is-private-exchange", listReq.IsPrivateExchange, `Filters each listing based on if it is a private exchange.`) - cmd.Flags().BoolVar(&listReq.IsStaffPick, "is-staff-pick", listReq.IsStaffPick, `Filters each listing based on whether it is a staff pick.`) - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().BoolVar(&listReq.IsFree, "is-free", listReq.IsFree, `Filters each listing based on if it is free. Wire name: 'is_free'.`) + cmd.Flags().BoolVar(&listReq.IsPrivateExchange, "is-private-exchange", listReq.IsPrivateExchange, `Filters each listing based on if it is a private exchange. Wire name: 'is_private_exchange'.`) + cmd.Flags().BoolVar(&listReq.IsStaffPick, "is-staff-pick", listReq.IsStaffPick, `Filters each listing based on whether it is a staff pick. Wire name: 'is_staff_pick'.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) // TODO: array: provider_ids // TODO: array: tags @@ -238,10 +238,10 @@ func newSearch() *cobra.Command { // TODO: array: assets // TODO: array: categories - cmd.Flags().BoolVar(&searchReq.IsFree, "is-free", searchReq.IsFree, ``) - cmd.Flags().BoolVar(&searchReq.IsPrivateExchange, "is-private-exchange", searchReq.IsPrivateExchange, ``) - cmd.Flags().IntVar(&searchReq.PageSize, "page-size", searchReq.PageSize, ``) - cmd.Flags().StringVar(&searchReq.PageToken, "page-token", searchReq.PageToken, ``) + cmd.Flags().BoolVar(&searchReq.IsFree, "is-free", searchReq.IsFree, `Wire name: 'is_free'.`) + cmd.Flags().BoolVar(&searchReq.IsPrivateExchange, "is-private-exchange", searchReq.IsPrivateExchange, `Wire name: 'is_private_exchange'.`) + cmd.Flags().IntVar(&searchReq.PageSize, "page-size", searchReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&searchReq.PageToken, "page-token", searchReq.PageToken, `Wire name: 'page_token'.`) // TODO: array: provider_ids cmd.Use = "search QUERY" diff --git a/cmd/workspace/consumer-personalization-requests/consumer-personalization-requests.go b/cmd/workspace/consumer-personalization-requests/consumer-personalization-requests.go index cfafe2072e..eb8713ed0e 100755 --- a/cmd/workspace/consumer-personalization-requests/consumer-personalization-requests.go +++ b/cmd/workspace/consumer-personalization-requests/consumer-personalization-requests.go @@ -60,12 +60,12 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, ``) - cmd.Flags().StringVar(&createReq.Company, "company", createReq.Company, ``) - cmd.Flags().StringVar(&createReq.FirstName, "first-name", createReq.FirstName, ``) - cmd.Flags().BoolVar(&createReq.IsFromLighthouse, "is-from-lighthouse", createReq.IsFromLighthouse, ``) - cmd.Flags().StringVar(&createReq.LastName, "last-name", createReq.LastName, ``) - cmd.Flags().Var(&createReq.RecipientType, "recipient-type", `Supported values: [DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS, DELTA_SHARING_RECIPIENT_TYPE_OPEN]`) + cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `Wire name: 'comment'.`) + cmd.Flags().StringVar(&createReq.Company, "company", createReq.Company, `Wire name: 'company'.`) + cmd.Flags().StringVar(&createReq.FirstName, "first-name", createReq.FirstName, `Wire name: 'first_name'.`) + cmd.Flags().BoolVar(&createReq.IsFromLighthouse, "is-from-lighthouse", createReq.IsFromLighthouse, `Wire name: 'is_from_lighthouse'.`) + cmd.Flags().StringVar(&createReq.LastName, "last-name", createReq.LastName, `Wire name: 'last_name'.`) + cmd.Flags().Var(&createReq.RecipientType, "recipient-type", `Supported values: [DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS, DELTA_SHARING_RECIPIENT_TYPE_OPEN]. Wire name: 'recipient_type'.`) cmd.Use = "create LISTING_ID" cmd.Short = `Create a personalization request.` @@ -188,8 +188,8 @@ func newList() *cobra.Command { var listReq marketplace.ListAllPersonalizationRequestsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List all personalization requests.` diff --git a/cmd/workspace/consumer-providers/consumer-providers.go b/cmd/workspace/consumer-providers/consumer-providers.go index 2965644ba6..889c01c266 100755 --- a/cmd/workspace/consumer-providers/consumer-providers.go +++ b/cmd/workspace/consumer-providers/consumer-providers.go @@ -175,9 +175,9 @@ func newList() *cobra.Command { var listReq marketplace.ListConsumerProvidersRequest - cmd.Flags().BoolVar(&listReq.IsFeatured, "is-featured", listReq.IsFeatured, ``) - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().BoolVar(&listReq.IsFeatured, "is-featured", listReq.IsFeatured, `Wire name: 'is_featured'.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List providers.` diff --git a/cmd/workspace/credentials/credentials.go b/cmd/workspace/credentials/credentials.go index 578e4fdf22..2a40f5dabf 100755 --- a/cmd/workspace/credentials/credentials.go +++ b/cmd/workspace/credentials/credentials.go @@ -73,11 +73,11 @@ func newCreateCredential() *cobra.Command { // TODO: complex arg: aws_iam_role // TODO: complex arg: azure_managed_identity // TODO: complex arg: azure_service_principal - cmd.Flags().StringVar(&createCredentialReq.Comment, "comment", createCredentialReq.Comment, `Comment associated with the credential.`) + cmd.Flags().StringVar(&createCredentialReq.Comment, "comment", createCredentialReq.Comment, `Comment associated with the credential. Wire name: 'comment'.`) // TODO: complex arg: databricks_gcp_service_account - cmd.Flags().Var(&createCredentialReq.Purpose, "purpose", `Indicates the purpose of the credential. Supported values: [SERVICE, STORAGE]`) - cmd.Flags().BoolVar(&createCredentialReq.ReadOnly, "read-only", createCredentialReq.ReadOnly, `Whether the credential is usable only for read operations.`) - cmd.Flags().BoolVar(&createCredentialReq.SkipValidation, "skip-validation", createCredentialReq.SkipValidation, `Optional.`) + cmd.Flags().Var(&createCredentialReq.Purpose, "purpose", `Indicates the purpose of the credential. Supported values: [SERVICE, STORAGE]. Wire name: 'purpose'.`) + cmd.Flags().BoolVar(&createCredentialReq.ReadOnly, "read-only", createCredentialReq.ReadOnly, `Whether the credential is usable only for read operations. Wire name: 'read_only'.`) + cmd.Flags().BoolVar(&createCredentialReq.SkipValidation, "skip-validation", createCredentialReq.SkipValidation, `Optional. Wire name: 'skip_validation'.`) cmd.Use = "create-credential NAME" cmd.Short = `Create a credential.` @@ -162,7 +162,7 @@ func newDeleteCredential() *cobra.Command { var deleteCredentialReq catalog.DeleteCredentialRequest - cmd.Flags().BoolVar(&deleteCredentialReq.Force, "force", deleteCredentialReq.Force, `Force an update even if there are dependent services (when purpose is **SERVICE**) or dependent external locations and external tables (when purpose is **STORAGE**).`) + cmd.Flags().BoolVar(&deleteCredentialReq.Force, "force", deleteCredentialReq.Force, `Force an update even if there are dependent services (when purpose is **SERVICE**) or dependent external locations and external tables (when purpose is **STORAGE**). Wire name: 'force'.`) cmd.Use = "delete-credential NAME_ARG" cmd.Short = `Delete a credential.` @@ -364,10 +364,10 @@ func newListCredentials() *cobra.Command { var listCredentialsReq catalog.ListCredentialsRequest - cmd.Flags().BoolVar(&listCredentialsReq.IncludeUnbound, "include-unbound", listCredentialsReq.IncludeUnbound, `Whether to include credentials not bound to the workspace.`) - cmd.Flags().IntVar(&listCredentialsReq.MaxResults, "max-results", listCredentialsReq.MaxResults, `Maximum number of credentials to return.`) - cmd.Flags().StringVar(&listCredentialsReq.PageToken, "page-token", listCredentialsReq.PageToken, `Opaque token to retrieve the next page of results.`) - cmd.Flags().Var(&listCredentialsReq.Purpose, "purpose", `Return only credentials for the specified purpose. Supported values: [SERVICE, STORAGE]`) + cmd.Flags().BoolVar(&listCredentialsReq.IncludeUnbound, "include-unbound", listCredentialsReq.IncludeUnbound, `Whether to include credentials not bound to the workspace. Wire name: 'include_unbound'.`) + cmd.Flags().IntVar(&listCredentialsReq.MaxResults, "max-results", listCredentialsReq.MaxResults, `Maximum number of credentials to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listCredentialsReq.PageToken, "page-token", listCredentialsReq.PageToken, `Opaque token to retrieve the next page of results. Wire name: 'page_token'.`) + cmd.Flags().Var(&listCredentialsReq.Purpose, "purpose", `Return only credentials for the specified purpose. Supported values: [SERVICE, STORAGE]. Wire name: 'purpose'.`) cmd.Use = "list-credentials" cmd.Short = `List credentials.` @@ -433,14 +433,14 @@ func newUpdateCredential() *cobra.Command { // TODO: complex arg: aws_iam_role // TODO: complex arg: azure_managed_identity // TODO: complex arg: azure_service_principal - cmd.Flags().StringVar(&updateCredentialReq.Comment, "comment", updateCredentialReq.Comment, `Comment associated with the credential.`) + cmd.Flags().StringVar(&updateCredentialReq.Comment, "comment", updateCredentialReq.Comment, `Comment associated with the credential. Wire name: 'comment'.`) // TODO: complex arg: databricks_gcp_service_account - cmd.Flags().BoolVar(&updateCredentialReq.Force, "force", updateCredentialReq.Force, `Force an update even if there are dependent services (when purpose is **SERVICE**) or dependent external locations and external tables (when purpose is **STORAGE**).`) - cmd.Flags().Var(&updateCredentialReq.IsolationMode, "isolation-mode", `Whether the current securable is accessible from all workspaces or a specific set of workspaces. Supported values: [ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN]`) - cmd.Flags().StringVar(&updateCredentialReq.NewName, "new-name", updateCredentialReq.NewName, `New name of credential.`) - cmd.Flags().StringVar(&updateCredentialReq.Owner, "owner", updateCredentialReq.Owner, `Username of current owner of credential.`) - cmd.Flags().BoolVar(&updateCredentialReq.ReadOnly, "read-only", updateCredentialReq.ReadOnly, `Whether the credential is usable only for read operations.`) - cmd.Flags().BoolVar(&updateCredentialReq.SkipValidation, "skip-validation", updateCredentialReq.SkipValidation, `Supply true to this argument to skip validation of the updated credential.`) + cmd.Flags().BoolVar(&updateCredentialReq.Force, "force", updateCredentialReq.Force, `Force an update even if there are dependent services (when purpose is **SERVICE**) or dependent external locations and external tables (when purpose is **STORAGE**). Wire name: 'force'.`) + cmd.Flags().Var(&updateCredentialReq.IsolationMode, "isolation-mode", `Whether the current securable is accessible from all workspaces or a specific set of workspaces. Supported values: [ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN]. Wire name: 'isolation_mode'.`) + cmd.Flags().StringVar(&updateCredentialReq.NewName, "new-name", updateCredentialReq.NewName, `New name of credential. Wire name: 'new_name'.`) + cmd.Flags().StringVar(&updateCredentialReq.Owner, "owner", updateCredentialReq.Owner, `Username of current owner of credential. Wire name: 'owner'.`) + cmd.Flags().BoolVar(&updateCredentialReq.ReadOnly, "read-only", updateCredentialReq.ReadOnly, `Whether the credential is usable only for read operations. Wire name: 'read_only'.`) + cmd.Flags().BoolVar(&updateCredentialReq.SkipValidation, "skip-validation", updateCredentialReq.SkipValidation, `Supply true to this argument to skip validation of the updated credential. Wire name: 'skip_validation'.`) cmd.Use = "update-credential NAME_ARG" cmd.Short = `Update a credential.` @@ -519,12 +519,12 @@ func newValidateCredential() *cobra.Command { // TODO: complex arg: aws_iam_role // TODO: complex arg: azure_managed_identity - cmd.Flags().StringVar(&validateCredentialReq.CredentialName, "credential-name", validateCredentialReq.CredentialName, `Required.`) + cmd.Flags().StringVar(&validateCredentialReq.CredentialName, "credential-name", validateCredentialReq.CredentialName, `Required. Wire name: 'credential_name'.`) // TODO: complex arg: databricks_gcp_service_account - cmd.Flags().StringVar(&validateCredentialReq.ExternalLocationName, "external-location-name", validateCredentialReq.ExternalLocationName, `The name of an existing external location to validate.`) - cmd.Flags().Var(&validateCredentialReq.Purpose, "purpose", `The purpose of the credential. Supported values: [SERVICE, STORAGE]`) - cmd.Flags().BoolVar(&validateCredentialReq.ReadOnly, "read-only", validateCredentialReq.ReadOnly, `Whether the credential is only usable for read operations.`) - cmd.Flags().StringVar(&validateCredentialReq.Url, "url", validateCredentialReq.Url, `The external location url to validate.`) + cmd.Flags().StringVar(&validateCredentialReq.ExternalLocationName, "external-location-name", validateCredentialReq.ExternalLocationName, `The name of an existing external location to validate. Wire name: 'external_location_name'.`) + cmd.Flags().Var(&validateCredentialReq.Purpose, "purpose", `The purpose of the credential. Supported values: [SERVICE, STORAGE]. Wire name: 'purpose'.`) + cmd.Flags().BoolVar(&validateCredentialReq.ReadOnly, "read-only", validateCredentialReq.ReadOnly, `Whether the credential is only usable for read operations. Wire name: 'read_only'.`) + cmd.Flags().StringVar(&validateCredentialReq.Url, "url", validateCredentialReq.Url, `The external location url to validate. Wire name: 'url'.`) cmd.Use = "validate-credential" cmd.Short = `Validate a credential.` diff --git a/cmd/workspace/dashboard-email-subscriptions/dashboard-email-subscriptions.go b/cmd/workspace/dashboard-email-subscriptions/dashboard-email-subscriptions.go index 0c4069c772..da4ca6969d 100755 --- a/cmd/workspace/dashboard-email-subscriptions/dashboard-email-subscriptions.go +++ b/cmd/workspace/dashboard-email-subscriptions/dashboard-email-subscriptions.go @@ -54,7 +54,7 @@ func newDelete() *cobra.Command { var deleteReq settings.DeleteDashboardEmailSubscriptionsRequest - cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "delete" cmd.Short = `Delete the Dashboard Email Subscriptions setting.` @@ -107,7 +107,7 @@ func newGet() *cobra.Command { var getReq settings.GetDashboardEmailSubscriptionsRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the Dashboard Email Subscriptions setting.` diff --git a/cmd/workspace/dashboard-widgets/dashboard-widgets.go b/cmd/workspace/dashboard-widgets/dashboard-widgets.go index 57273a3b2a..6279584fa8 100755 --- a/cmd/workspace/dashboard-widgets/dashboard-widgets.go +++ b/cmd/workspace/dashboard-widgets/dashboard-widgets.go @@ -64,8 +64,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Text, "text", createReq.Text, `If this is a textbox widget, the application displays this text.`) - cmd.Flags().StringVar(&createReq.VisualizationId, "visualization-id", createReq.VisualizationId, `Query Vizualization ID returned by :method:queryvisualizations/create.`) + cmd.Flags().StringVar(&createReq.Text, "text", createReq.Text, `If this is a textbox widget, the application displays this text. Wire name: 'text'.`) + cmd.Flags().StringVar(&createReq.VisualizationId, "visualization-id", createReq.VisualizationId, `Query Vizualization ID returned by :method:queryvisualizations/create. Wire name: 'visualization_id'.`) cmd.Use = "create" cmd.Short = `Add widget to a dashboard.` @@ -187,8 +187,8 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Text, "text", updateReq.Text, `If this is a textbox widget, the application displays this text.`) - cmd.Flags().StringVar(&updateReq.VisualizationId, "visualization-id", updateReq.VisualizationId, `Query Vizualization ID returned by :method:queryvisualizations/create.`) + cmd.Flags().StringVar(&updateReq.Text, "text", updateReq.Text, `If this is a textbox widget, the application displays this text. Wire name: 'text'.`) + cmd.Flags().StringVar(&updateReq.VisualizationId, "visualization-id", updateReq.VisualizationId, `Query Vizualization ID returned by :method:queryvisualizations/create. Wire name: 'visualization_id'.`) cmd.Use = "update ID" cmd.Short = `Update existing widget.` diff --git a/cmd/workspace/dashboards/dashboards.go b/cmd/workspace/dashboards/dashboards.go index 4a5d6dd224..92fc71fc3e 100755 --- a/cmd/workspace/dashboards/dashboards.go +++ b/cmd/workspace/dashboards/dashboards.go @@ -169,10 +169,10 @@ func newList() *cobra.Command { var listReq sql.ListDashboardsRequest - cmd.Flags().Var(&listReq.Order, "order", `Name of dashboard attribute to order by. Supported values: [created_at, name]`) - cmd.Flags().IntVar(&listReq.Page, "page", listReq.Page, `Page number to retrieve.`) - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Number of dashboards to return per page.`) - cmd.Flags().StringVar(&listReq.Q, "q", listReq.Q, `Full text search term.`) + cmd.Flags().Var(&listReq.Order, "order", `Name of dashboard attribute to order by. Supported values: [created_at, name]. Wire name: 'order'.`) + cmd.Flags().IntVar(&listReq.Page, "page", listReq.Page, `Page number to retrieve. Wire name: 'page'.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Number of dashboards to return per page. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.Q, "q", listReq.Q, `Full text search term. Wire name: 'q'.`) cmd.Use = "list" cmd.Short = `Get dashboard objects.` @@ -281,8 +281,8 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `The title of this dashboard that appears in list views and at the top of the dashboard page.`) - cmd.Flags().Var(&updateReq.RunAsRole, "run-as-role", `Sets the **Run as** role for the object. Supported values: [owner, viewer]`) + cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `The title of this dashboard that appears in list views and at the top of the dashboard page. Wire name: 'name'.`) + cmd.Flags().Var(&updateReq.RunAsRole, "run-as-role", `Sets the **Run as** role for the object. Supported values: [owner, viewer]. Wire name: 'run_as_role'.`) // TODO: array: tags cmd.Use = "update DASHBOARD_ID" diff --git a/cmd/workspace/data-quality/data-quality.go b/cmd/workspace/data-quality/data-quality.go index 304bd231c8..b929051866 100755 --- a/cmd/workspace/data-quality/data-quality.go +++ b/cmd/workspace/data-quality/data-quality.go @@ -710,8 +710,8 @@ func newListMonitor() *cobra.Command { var listMonitorReq dataquality.ListMonitorRequest - cmd.Flags().IntVar(&listMonitorReq.PageSize, "page-size", listMonitorReq.PageSize, ``) - cmd.Flags().StringVar(&listMonitorReq.PageToken, "page-token", listMonitorReq.PageToken, ``) + cmd.Flags().IntVar(&listMonitorReq.PageSize, "page-size", listMonitorReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listMonitorReq.PageToken, "page-token", listMonitorReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list-monitor" cmd.Short = `List monitors.` @@ -761,8 +761,8 @@ func newListRefresh() *cobra.Command { var listRefreshReq dataquality.ListRefreshRequest - cmd.Flags().IntVar(&listRefreshReq.PageSize, "page-size", listRefreshReq.PageSize, ``) - cmd.Flags().StringVar(&listRefreshReq.PageToken, "page-token", listRefreshReq.PageToken, ``) + cmd.Flags().IntVar(&listRefreshReq.PageSize, "page-size", listRefreshReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listRefreshReq.PageToken, "page-token", listRefreshReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list-refresh OBJECT_TYPE OBJECT_ID" cmd.Short = `List refreshes.` diff --git a/cmd/workspace/database/database.go b/cmd/workspace/database/database.go index 89246ea2d7..5c19c891af 100755 --- a/cmd/workspace/database/database.go +++ b/cmd/workspace/database/database.go @@ -82,7 +82,7 @@ func newCreateDatabaseCatalog() *cobra.Command { cmd.Flags().Var(&createDatabaseCatalogJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&createDatabaseCatalogReq.Catalog.CreateDatabaseIfNotExists, "create-database-if-not-exists", createDatabaseCatalogReq.Catalog.CreateDatabaseIfNotExists, ``) + cmd.Flags().BoolVar(&createDatabaseCatalogReq.Catalog.CreateDatabaseIfNotExists, "create-database-if-not-exists", createDatabaseCatalogReq.Catalog.CreateDatabaseIfNotExists, `Wire name: 'create_database_if_not_exists'.`) cmd.Use = "create-database-catalog NAME DATABASE_INSTANCE_NAME DATABASE_NAME" cmd.Short = `Create a Database Catalog.` @@ -177,17 +177,17 @@ func newCreateDatabaseInstance() *cobra.Command { cmd.Flags().Var(&createDatabaseInstanceJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createDatabaseInstanceReq.DatabaseInstance.Capacity, "capacity", createDatabaseInstanceReq.DatabaseInstance.Capacity, `The sku of the instance.`) + cmd.Flags().StringVar(&createDatabaseInstanceReq.DatabaseInstance.Capacity, "capacity", createDatabaseInstanceReq.DatabaseInstance.Capacity, `The sku of the instance. Wire name: 'capacity'.`) // TODO: array: child_instance_refs // TODO: array: custom_tags // TODO: array: effective_custom_tags - cmd.Flags().BoolVar(&createDatabaseInstanceReq.DatabaseInstance.EnablePgNativeLogin, "enable-pg-native-login", createDatabaseInstanceReq.DatabaseInstance.EnablePgNativeLogin, `Whether to enable PG native password login on the instance.`) - cmd.Flags().BoolVar(&createDatabaseInstanceReq.DatabaseInstance.EnableReadableSecondaries, "enable-readable-secondaries", createDatabaseInstanceReq.DatabaseInstance.EnableReadableSecondaries, `Whether to enable secondaries to serve read-only traffic.`) - cmd.Flags().IntVar(&createDatabaseInstanceReq.DatabaseInstance.NodeCount, "node-count", createDatabaseInstanceReq.DatabaseInstance.NodeCount, `The number of nodes in the instance, composed of 1 primary and 0 or more secondaries.`) + cmd.Flags().BoolVar(&createDatabaseInstanceReq.DatabaseInstance.EnablePgNativeLogin, "enable-pg-native-login", createDatabaseInstanceReq.DatabaseInstance.EnablePgNativeLogin, `Whether to enable PG native password login on the instance. Wire name: 'enable_pg_native_login'.`) + cmd.Flags().BoolVar(&createDatabaseInstanceReq.DatabaseInstance.EnableReadableSecondaries, "enable-readable-secondaries", createDatabaseInstanceReq.DatabaseInstance.EnableReadableSecondaries, `Whether to enable secondaries to serve read-only traffic. Wire name: 'enable_readable_secondaries'.`) + cmd.Flags().IntVar(&createDatabaseInstanceReq.DatabaseInstance.NodeCount, "node-count", createDatabaseInstanceReq.DatabaseInstance.NodeCount, `The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Wire name: 'node_count'.`) // TODO: complex arg: parent_instance_ref - cmd.Flags().IntVar(&createDatabaseInstanceReq.DatabaseInstance.RetentionWindowInDays, "retention-window-in-days", createDatabaseInstanceReq.DatabaseInstance.RetentionWindowInDays, `The retention window for the instance.`) - cmd.Flags().BoolVar(&createDatabaseInstanceReq.DatabaseInstance.Stopped, "stopped", createDatabaseInstanceReq.DatabaseInstance.Stopped, `Whether to stop the instance.`) - cmd.Flags().StringVar(&createDatabaseInstanceReq.DatabaseInstance.UsagePolicyId, "usage-policy-id", createDatabaseInstanceReq.DatabaseInstance.UsagePolicyId, `The desired usage policy to associate with the instance.`) + cmd.Flags().IntVar(&createDatabaseInstanceReq.DatabaseInstance.RetentionWindowInDays, "retention-window-in-days", createDatabaseInstanceReq.DatabaseInstance.RetentionWindowInDays, `The retention window for the instance. Wire name: 'retention_window_in_days'.`) + cmd.Flags().BoolVar(&createDatabaseInstanceReq.DatabaseInstance.Stopped, "stopped", createDatabaseInstanceReq.DatabaseInstance.Stopped, `Whether to stop the instance. Wire name: 'stopped'.`) + cmd.Flags().StringVar(&createDatabaseInstanceReq.DatabaseInstance.UsagePolicyId, "usage-policy-id", createDatabaseInstanceReq.DatabaseInstance.UsagePolicyId, `The desired usage policy to associate with the instance. Wire name: 'usage_policy_id'.`) cmd.Use = "create-database-instance NAME" cmd.Short = `Create a Database Instance.` @@ -281,12 +281,12 @@ func newCreateDatabaseInstanceRole() *cobra.Command { cmd.Flags().Var(&createDatabaseInstanceRoleJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createDatabaseInstanceRoleReq.DatabaseInstanceName, "database-instance-name", createDatabaseInstanceRoleReq.DatabaseInstanceName, ``) + cmd.Flags().StringVar(&createDatabaseInstanceRoleReq.DatabaseInstanceName, "database-instance-name", createDatabaseInstanceRoleReq.DatabaseInstanceName, `Wire name: 'database_instance_name'.`) // TODO: complex arg: attributes // TODO: complex arg: effective_attributes - cmd.Flags().Var(&createDatabaseInstanceRoleReq.DatabaseInstanceRole.IdentityType, "identity-type", `The type of the role. Supported values: [GROUP, PG_ONLY, SERVICE_PRINCIPAL, USER]`) - cmd.Flags().StringVar(&createDatabaseInstanceRoleReq.DatabaseInstanceRole.InstanceName, "instance-name", createDatabaseInstanceRoleReq.DatabaseInstanceRole.InstanceName, ``) - cmd.Flags().Var(&createDatabaseInstanceRoleReq.DatabaseInstanceRole.MembershipRole, "membership-role", `An enum value for a standard role that this role is a member of. Supported values: [DATABRICKS_SUPERUSER]`) + cmd.Flags().Var(&createDatabaseInstanceRoleReq.DatabaseInstanceRole.IdentityType, "identity-type", `The type of the role. Supported values: [GROUP, PG_ONLY, SERVICE_PRINCIPAL, USER]. Wire name: 'identity_type'.`) + cmd.Flags().StringVar(&createDatabaseInstanceRoleReq.DatabaseInstanceRole.InstanceName, "instance-name", createDatabaseInstanceRoleReq.DatabaseInstanceRole.InstanceName, `Wire name: 'instance_name'.`) + cmd.Flags().Var(&createDatabaseInstanceRoleReq.DatabaseInstanceRole.MembershipRole, "membership-role", `An enum value for a standard role that this role is a member of. Supported values: [DATABRICKS_SUPERUSER]. Wire name: 'membership_role'.`) cmd.Use = "create-database-instance-role INSTANCE_NAME NAME" cmd.Short = `Create a role for a Database Instance.` @@ -373,8 +373,8 @@ func newCreateDatabaseTable() *cobra.Command { cmd.Flags().Var(&createDatabaseTableJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createDatabaseTableReq.Table.DatabaseInstanceName, "database-instance-name", createDatabaseTableReq.Table.DatabaseInstanceName, `Name of the target database instance.`) - cmd.Flags().StringVar(&createDatabaseTableReq.Table.LogicalDatabaseName, "logical-database-name", createDatabaseTableReq.Table.LogicalDatabaseName, `Target Postgres database object (logical database) name for this table.`) + cmd.Flags().StringVar(&createDatabaseTableReq.Table.DatabaseInstanceName, "database-instance-name", createDatabaseTableReq.Table.DatabaseInstanceName, `Name of the target database instance. Wire name: 'database_instance_name'.`) + cmd.Flags().StringVar(&createDatabaseTableReq.Table.LogicalDatabaseName, "logical-database-name", createDatabaseTableReq.Table.LogicalDatabaseName, `Target Postgres database object (logical database) name for this table. Wire name: 'logical_database_name'.`) cmd.Use = "create-database-table NAME" cmd.Short = `Create a Database Table.` @@ -460,8 +460,8 @@ func newCreateSyncedDatabaseTable() *cobra.Command { cmd.Flags().Var(&createSyncedDatabaseTableJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: data_synchronization_status - cmd.Flags().StringVar(&createSyncedDatabaseTableReq.SyncedTable.DatabaseInstanceName, "database-instance-name", createSyncedDatabaseTableReq.SyncedTable.DatabaseInstanceName, `Name of the target database instance.`) - cmd.Flags().StringVar(&createSyncedDatabaseTableReq.SyncedTable.LogicalDatabaseName, "logical-database-name", createSyncedDatabaseTableReq.SyncedTable.LogicalDatabaseName, `Target Postgres database object (logical database) name for this table.`) + cmd.Flags().StringVar(&createSyncedDatabaseTableReq.SyncedTable.DatabaseInstanceName, "database-instance-name", createSyncedDatabaseTableReq.SyncedTable.DatabaseInstanceName, `Name of the target database instance. Wire name: 'database_instance_name'.`) + cmd.Flags().StringVar(&createSyncedDatabaseTableReq.SyncedTable.LogicalDatabaseName, "logical-database-name", createSyncedDatabaseTableReq.SyncedTable.LogicalDatabaseName, `Target Postgres database object (logical database) name for this table. Wire name: 'logical_database_name'.`) // TODO: complex arg: spec cmd.Use = "create-synced-database-table NAME" @@ -590,8 +590,8 @@ func newDeleteDatabaseInstance() *cobra.Command { var deleteDatabaseInstanceReq database.DeleteDatabaseInstanceRequest - cmd.Flags().BoolVar(&deleteDatabaseInstanceReq.Force, "force", deleteDatabaseInstanceReq.Force, `By default, a instance cannot be deleted if it has descendant instances created via PITR.`) - cmd.Flags().BoolVar(&deleteDatabaseInstanceReq.Purge, "purge", deleteDatabaseInstanceReq.Purge, `Deprecated.`) + cmd.Flags().BoolVar(&deleteDatabaseInstanceReq.Force, "force", deleteDatabaseInstanceReq.Force, `By default, a instance cannot be deleted if it has descendant instances created via PITR. Wire name: 'force'.`) + cmd.Flags().BoolVar(&deleteDatabaseInstanceReq.Purge, "purge", deleteDatabaseInstanceReq.Purge, `Deprecated. Wire name: 'purge'.`) cmd.Use = "delete-database-instance NAME" cmd.Short = `Delete a Database Instance.` @@ -647,8 +647,8 @@ func newDeleteDatabaseInstanceRole() *cobra.Command { var deleteDatabaseInstanceRoleReq database.DeleteDatabaseInstanceRoleRequest - cmd.Flags().BoolVar(&deleteDatabaseInstanceRoleReq.AllowMissing, "allow-missing", deleteDatabaseInstanceRoleReq.AllowMissing, `This is the AIP standard name for the equivalent of Postgres' IF EXISTS option.`) - cmd.Flags().StringVar(&deleteDatabaseInstanceRoleReq.ReassignOwnedTo, "reassign-owned-to", deleteDatabaseInstanceRoleReq.ReassignOwnedTo, ``) + cmd.Flags().BoolVar(&deleteDatabaseInstanceRoleReq.AllowMissing, "allow-missing", deleteDatabaseInstanceRoleReq.AllowMissing, `This is the AIP standard name for the equivalent of Postgres' IF EXISTS option. Wire name: 'allow_missing'.`) + cmd.Flags().StringVar(&deleteDatabaseInstanceRoleReq.ReassignOwnedTo, "reassign-owned-to", deleteDatabaseInstanceRoleReq.ReassignOwnedTo, `Wire name: 'reassign_owned_to'.`) cmd.Use = "delete-database-instance-role INSTANCE_NAME NAME" cmd.Short = `Delete a role for a Database Instance.` @@ -809,7 +809,7 @@ func newFindDatabaseInstanceByUid() *cobra.Command { var findDatabaseInstanceByUidReq database.FindDatabaseInstanceByUidRequest - cmd.Flags().StringVar(&findDatabaseInstanceByUidReq.Uid, "uid", findDatabaseInstanceByUidReq.Uid, `UID of the cluster to get.`) + cmd.Flags().StringVar(&findDatabaseInstanceByUidReq.Uid, "uid", findDatabaseInstanceByUidReq.Uid, `UID of the cluster to get. Wire name: 'uid'.`) cmd.Use = "find-database-instance-by-uid" cmd.Short = `Find a Database Instance by uid.` @@ -865,7 +865,7 @@ func newGenerateDatabaseCredential() *cobra.Command { // TODO: array: claims // TODO: array: instance_names - cmd.Flags().StringVar(&generateDatabaseCredentialReq.RequestId, "request-id", generateDatabaseCredentialReq.RequestId, ``) + cmd.Flags().StringVar(&generateDatabaseCredentialReq.RequestId, "request-id", generateDatabaseCredentialReq.RequestId, `Wire name: 'request_id'.`) cmd.Use = "generate-database-credential" cmd.Short = `Generates a credential that can be used to access database instances.` @@ -1193,8 +1193,8 @@ func newListDatabaseCatalogs() *cobra.Command { var listDatabaseCatalogsReq database.ListDatabaseCatalogsRequest - cmd.Flags().IntVar(&listDatabaseCatalogsReq.PageSize, "page-size", listDatabaseCatalogsReq.PageSize, `Upper bound for items returned.`) - cmd.Flags().StringVar(&listDatabaseCatalogsReq.PageToken, "page-token", listDatabaseCatalogsReq.PageToken, `Pagination token to go to the next page of synced database tables.`) + cmd.Flags().IntVar(&listDatabaseCatalogsReq.PageSize, "page-size", listDatabaseCatalogsReq.PageSize, `Upper bound for items returned. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listDatabaseCatalogsReq.PageToken, "page-token", listDatabaseCatalogsReq.PageToken, `Pagination token to go to the next page of synced database tables. Wire name: 'page_token'.`) cmd.Use = "list-database-catalogs INSTANCE_NAME" cmd.Short = `List all Database Catalogs in a Database Instance.` @@ -1252,8 +1252,8 @@ func newListDatabaseInstanceRoles() *cobra.Command { var listDatabaseInstanceRolesReq database.ListDatabaseInstanceRolesRequest - cmd.Flags().IntVar(&listDatabaseInstanceRolesReq.PageSize, "page-size", listDatabaseInstanceRolesReq.PageSize, `Upper bound for items returned.`) - cmd.Flags().StringVar(&listDatabaseInstanceRolesReq.PageToken, "page-token", listDatabaseInstanceRolesReq.PageToken, `Pagination token to go to the next page of Database Instances.`) + cmd.Flags().IntVar(&listDatabaseInstanceRolesReq.PageSize, "page-size", listDatabaseInstanceRolesReq.PageSize, `Upper bound for items returned. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listDatabaseInstanceRolesReq.PageToken, "page-token", listDatabaseInstanceRolesReq.PageToken, `Pagination token to go to the next page of Database Instances. Wire name: 'page_token'.`) cmd.Use = "list-database-instance-roles INSTANCE_NAME" cmd.Short = `List roles for a Database Instance.` @@ -1312,8 +1312,8 @@ func newListDatabaseInstances() *cobra.Command { var listDatabaseInstancesReq database.ListDatabaseInstancesRequest - cmd.Flags().IntVar(&listDatabaseInstancesReq.PageSize, "page-size", listDatabaseInstancesReq.PageSize, `Upper bound for items returned.`) - cmd.Flags().StringVar(&listDatabaseInstancesReq.PageToken, "page-token", listDatabaseInstancesReq.PageToken, `Pagination token to go to the next page of Database Instances.`) + cmd.Flags().IntVar(&listDatabaseInstancesReq.PageSize, "page-size", listDatabaseInstancesReq.PageSize, `Upper bound for items returned. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listDatabaseInstancesReq.PageToken, "page-token", listDatabaseInstancesReq.PageToken, `Pagination token to go to the next page of Database Instances. Wire name: 'page_token'.`) cmd.Use = "list-database-instances" cmd.Short = `List Database Instances.` @@ -1361,8 +1361,8 @@ func newListSyncedDatabaseTables() *cobra.Command { var listSyncedDatabaseTablesReq database.ListSyncedDatabaseTablesRequest - cmd.Flags().IntVar(&listSyncedDatabaseTablesReq.PageSize, "page-size", listSyncedDatabaseTablesReq.PageSize, `Upper bound for items returned.`) - cmd.Flags().StringVar(&listSyncedDatabaseTablesReq.PageToken, "page-token", listSyncedDatabaseTablesReq.PageToken, `Pagination token to go to the next page of synced database tables.`) + cmd.Flags().IntVar(&listSyncedDatabaseTablesReq.PageSize, "page-size", listSyncedDatabaseTablesReq.PageSize, `Upper bound for items returned. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listSyncedDatabaseTablesReq.PageToken, "page-token", listSyncedDatabaseTablesReq.PageToken, `Pagination token to go to the next page of synced database tables. Wire name: 'page_token'.`) cmd.Use = "list-synced-database-tables INSTANCE_NAME" cmd.Short = `List all synced database tables in a Database Instance.` @@ -1424,7 +1424,7 @@ func newUpdateDatabaseCatalog() *cobra.Command { cmd.Flags().Var(&updateDatabaseCatalogJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&updateDatabaseCatalogReq.DatabaseCatalog.CreateDatabaseIfNotExists, "create-database-if-not-exists", updateDatabaseCatalogReq.DatabaseCatalog.CreateDatabaseIfNotExists, ``) + cmd.Flags().BoolVar(&updateDatabaseCatalogReq.DatabaseCatalog.CreateDatabaseIfNotExists, "create-database-if-not-exists", updateDatabaseCatalogReq.DatabaseCatalog.CreateDatabaseIfNotExists, `Wire name: 'create_database_if_not_exists'.`) cmd.Use = "update-database-catalog NAME UPDATE_MASK DATABASE_INSTANCE_NAME DATABASE_NAME" cmd.Short = `Update a Database Catalog.` @@ -1518,17 +1518,17 @@ func newUpdateDatabaseInstance() *cobra.Command { cmd.Flags().Var(&updateDatabaseInstanceJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateDatabaseInstanceReq.DatabaseInstance.Capacity, "capacity", updateDatabaseInstanceReq.DatabaseInstance.Capacity, `The sku of the instance.`) + cmd.Flags().StringVar(&updateDatabaseInstanceReq.DatabaseInstance.Capacity, "capacity", updateDatabaseInstanceReq.DatabaseInstance.Capacity, `The sku of the instance. Wire name: 'capacity'.`) // TODO: array: child_instance_refs // TODO: array: custom_tags // TODO: array: effective_custom_tags - cmd.Flags().BoolVar(&updateDatabaseInstanceReq.DatabaseInstance.EnablePgNativeLogin, "enable-pg-native-login", updateDatabaseInstanceReq.DatabaseInstance.EnablePgNativeLogin, `Whether to enable PG native password login on the instance.`) - cmd.Flags().BoolVar(&updateDatabaseInstanceReq.DatabaseInstance.EnableReadableSecondaries, "enable-readable-secondaries", updateDatabaseInstanceReq.DatabaseInstance.EnableReadableSecondaries, `Whether to enable secondaries to serve read-only traffic.`) - cmd.Flags().IntVar(&updateDatabaseInstanceReq.DatabaseInstance.NodeCount, "node-count", updateDatabaseInstanceReq.DatabaseInstance.NodeCount, `The number of nodes in the instance, composed of 1 primary and 0 or more secondaries.`) + cmd.Flags().BoolVar(&updateDatabaseInstanceReq.DatabaseInstance.EnablePgNativeLogin, "enable-pg-native-login", updateDatabaseInstanceReq.DatabaseInstance.EnablePgNativeLogin, `Whether to enable PG native password login on the instance. Wire name: 'enable_pg_native_login'.`) + cmd.Flags().BoolVar(&updateDatabaseInstanceReq.DatabaseInstance.EnableReadableSecondaries, "enable-readable-secondaries", updateDatabaseInstanceReq.DatabaseInstance.EnableReadableSecondaries, `Whether to enable secondaries to serve read-only traffic. Wire name: 'enable_readable_secondaries'.`) + cmd.Flags().IntVar(&updateDatabaseInstanceReq.DatabaseInstance.NodeCount, "node-count", updateDatabaseInstanceReq.DatabaseInstance.NodeCount, `The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Wire name: 'node_count'.`) // TODO: complex arg: parent_instance_ref - cmd.Flags().IntVar(&updateDatabaseInstanceReq.DatabaseInstance.RetentionWindowInDays, "retention-window-in-days", updateDatabaseInstanceReq.DatabaseInstance.RetentionWindowInDays, `The retention window for the instance.`) - cmd.Flags().BoolVar(&updateDatabaseInstanceReq.DatabaseInstance.Stopped, "stopped", updateDatabaseInstanceReq.DatabaseInstance.Stopped, `Whether to stop the instance.`) - cmd.Flags().StringVar(&updateDatabaseInstanceReq.DatabaseInstance.UsagePolicyId, "usage-policy-id", updateDatabaseInstanceReq.DatabaseInstance.UsagePolicyId, `The desired usage policy to associate with the instance.`) + cmd.Flags().IntVar(&updateDatabaseInstanceReq.DatabaseInstance.RetentionWindowInDays, "retention-window-in-days", updateDatabaseInstanceReq.DatabaseInstance.RetentionWindowInDays, `The retention window for the instance. Wire name: 'retention_window_in_days'.`) + cmd.Flags().BoolVar(&updateDatabaseInstanceReq.DatabaseInstance.Stopped, "stopped", updateDatabaseInstanceReq.DatabaseInstance.Stopped, `Whether to stop the instance. Wire name: 'stopped'.`) + cmd.Flags().StringVar(&updateDatabaseInstanceReq.DatabaseInstance.UsagePolicyId, "usage-policy-id", updateDatabaseInstanceReq.DatabaseInstance.UsagePolicyId, `The desired usage policy to associate with the instance. Wire name: 'usage_policy_id'.`) cmd.Use = "update-database-instance NAME UPDATE_MASK" cmd.Short = `Update a Database Instance.` @@ -1605,8 +1605,8 @@ func newUpdateSyncedDatabaseTable() *cobra.Command { cmd.Flags().Var(&updateSyncedDatabaseTableJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: data_synchronization_status - cmd.Flags().StringVar(&updateSyncedDatabaseTableReq.SyncedTable.DatabaseInstanceName, "database-instance-name", updateSyncedDatabaseTableReq.SyncedTable.DatabaseInstanceName, `Name of the target database instance.`) - cmd.Flags().StringVar(&updateSyncedDatabaseTableReq.SyncedTable.LogicalDatabaseName, "logical-database-name", updateSyncedDatabaseTableReq.SyncedTable.LogicalDatabaseName, `Target Postgres database object (logical database) name for this table.`) + cmd.Flags().StringVar(&updateSyncedDatabaseTableReq.SyncedTable.DatabaseInstanceName, "database-instance-name", updateSyncedDatabaseTableReq.SyncedTable.DatabaseInstanceName, `Name of the target database instance. Wire name: 'database_instance_name'.`) + cmd.Flags().StringVar(&updateSyncedDatabaseTableReq.SyncedTable.LogicalDatabaseName, "logical-database-name", updateSyncedDatabaseTableReq.SyncedTable.LogicalDatabaseName, `Target Postgres database object (logical database) name for this table. Wire name: 'logical_database_name'.`) // TODO: complex arg: spec cmd.Use = "update-synced-database-table NAME UPDATE_MASK" diff --git a/cmd/workspace/default-namespace/default-namespace.go b/cmd/workspace/default-namespace/default-namespace.go index d5a24dbb7e..3b91bbf9ff 100755 --- a/cmd/workspace/default-namespace/default-namespace.go +++ b/cmd/workspace/default-namespace/default-namespace.go @@ -63,7 +63,7 @@ func newDelete() *cobra.Command { var deleteReq settings.DeleteDefaultNamespaceSettingRequest - cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "delete" cmd.Short = `Delete the default namespace setting.` @@ -120,7 +120,7 @@ func newGet() *cobra.Command { var getReq settings.GetDefaultNamespaceSettingRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the default namespace setting.` diff --git a/cmd/workspace/default-warehouse-id/default-warehouse-id.go b/cmd/workspace/default-warehouse-id/default-warehouse-id.go index dec4078fe9..d3f7eaa184 100755 --- a/cmd/workspace/default-warehouse-id/default-warehouse-id.go +++ b/cmd/workspace/default-warehouse-id/default-warehouse-id.go @@ -56,7 +56,7 @@ func newDelete() *cobra.Command { var deleteReq settings.DeleteDefaultWarehouseIdRequest - cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "delete" cmd.Short = `Delete the Default Warehouse Id setting.` @@ -109,7 +109,7 @@ func newGet() *cobra.Command { var getReq settings.GetDefaultWarehouseIdRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the Default Warehouse Id setting.` diff --git a/cmd/workspace/disable-legacy-access/disable-legacy-access.go b/cmd/workspace/disable-legacy-access/disable-legacy-access.go index 3447a8fb8a..b7a4d02fdc 100755 --- a/cmd/workspace/disable-legacy-access/disable-legacy-access.go +++ b/cmd/workspace/disable-legacy-access/disable-legacy-access.go @@ -57,7 +57,7 @@ func newDelete() *cobra.Command { var deleteReq settings.DeleteDisableLegacyAccessRequest - cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "delete" cmd.Short = `Delete Legacy Access Disablement Status.` @@ -110,7 +110,7 @@ func newGet() *cobra.Command { var getReq settings.GetDisableLegacyAccessRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Retrieve Legacy Access Disablement Status.` diff --git a/cmd/workspace/disable-legacy-dbfs/disable-legacy-dbfs.go b/cmd/workspace/disable-legacy-dbfs/disable-legacy-dbfs.go index fd1d3fb902..c45ad8c224 100755 --- a/cmd/workspace/disable-legacy-dbfs/disable-legacy-dbfs.go +++ b/cmd/workspace/disable-legacy-dbfs/disable-legacy-dbfs.go @@ -60,7 +60,7 @@ func newDelete() *cobra.Command { var deleteReq settings.DeleteDisableLegacyDbfsRequest - cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "delete" cmd.Short = `Delete the disable legacy DBFS setting.` @@ -114,7 +114,7 @@ func newGet() *cobra.Command { var getReq settings.GetDisableLegacyDbfsRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the disable legacy DBFS setting.` diff --git a/cmd/workspace/enhanced-security-monitoring/enhanced-security-monitoring.go b/cmd/workspace/enhanced-security-monitoring/enhanced-security-monitoring.go index 2621d13604..f021511926 100755 --- a/cmd/workspace/enhanced-security-monitoring/enhanced-security-monitoring.go +++ b/cmd/workspace/enhanced-security-monitoring/enhanced-security-monitoring.go @@ -57,7 +57,7 @@ func newGet() *cobra.Command { var getReq settings.GetEnhancedSecurityMonitoringSettingRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the enhanced security monitoring setting.` diff --git a/cmd/workspace/entity-tag-assignments/entity-tag-assignments.go b/cmd/workspace/entity-tag-assignments/entity-tag-assignments.go index 7dffa32804..737791287b 100755 --- a/cmd/workspace/entity-tag-assignments/entity-tag-assignments.go +++ b/cmd/workspace/entity-tag-assignments/entity-tag-assignments.go @@ -66,7 +66,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.TagAssignment.TagValue, "tag-value", createReq.TagAssignment.TagValue, `The value of the tag.`) + cmd.Flags().StringVar(&createReq.TagAssignment.TagValue, "tag-value", createReq.TagAssignment.TagValue, `The value of the tag. Wire name: 'tag_value'.`) cmd.Use = "create ENTITY_NAME TAG_KEY ENTITY_TYPE" cmd.Short = `Create an entity tag assignment.` @@ -296,8 +296,8 @@ func newList() *cobra.Command { var listReq catalog.ListEntityTagAssignmentsRequest - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Optional.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Optional.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Optional. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Optional. Wire name: 'page_token'.`) cmd.Use = "list ENTITY_TYPE ENTITY_NAME" cmd.Short = `List entity tag assignments.` @@ -364,7 +364,7 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.TagAssignment.TagValue, "tag-value", updateReq.TagAssignment.TagValue, `The value of the tag.`) + cmd.Flags().StringVar(&updateReq.TagAssignment.TagValue, "tag-value", updateReq.TagAssignment.TagValue, `The value of the tag. Wire name: 'tag_value'.`) cmd.Use = "update ENTITY_TYPE ENTITY_NAME TAG_KEY UPDATE_MASK" cmd.Short = `Update an entity tag assignment.` diff --git a/cmd/workspace/experiments/experiments.go b/cmd/workspace/experiments/experiments.go index 3b877589e7..c8eac1a3c6 100755 --- a/cmd/workspace/experiments/experiments.go +++ b/cmd/workspace/experiments/experiments.go @@ -103,7 +103,7 @@ func newCreateExperiment() *cobra.Command { cmd.Flags().Var(&createExperimentJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createExperimentReq.ArtifactLocation, "artifact-location", createExperimentReq.ArtifactLocation, `Location where all artifacts for the experiment are stored.`) + cmd.Flags().StringVar(&createExperimentReq.ArtifactLocation, "artifact-location", createExperimentReq.ArtifactLocation, `Location where all artifacts for the experiment are stored. Wire name: 'artifact_location'.`) // TODO: array: tags cmd.Use = "create-experiment NAME" @@ -191,10 +191,10 @@ func newCreateLoggedModel() *cobra.Command { cmd.Flags().Var(&createLoggedModelJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createLoggedModelReq.ModelType, "model-type", createLoggedModelReq.ModelType, `The type of the model, such as "Agent", "Classifier", "LLM".`) - cmd.Flags().StringVar(&createLoggedModelReq.Name, "name", createLoggedModelReq.Name, `The name of the model (optional).`) + cmd.Flags().StringVar(&createLoggedModelReq.ModelType, "model-type", createLoggedModelReq.ModelType, `The type of the model, such as "Agent", "Classifier", "LLM". Wire name: 'model_type'.`) + cmd.Flags().StringVar(&createLoggedModelReq.Name, "name", createLoggedModelReq.Name, `The name of the model (optional). Wire name: 'name'.`) // TODO: array: params - cmd.Flags().StringVar(&createLoggedModelReq.SourceRunId, "source-run-id", createLoggedModelReq.SourceRunId, `The ID of the run that created the model.`) + cmd.Flags().StringVar(&createLoggedModelReq.SourceRunId, "source-run-id", createLoggedModelReq.SourceRunId, `The ID of the run that created the model. Wire name: 'source_run_id'.`) // TODO: array: tags cmd.Use = "create-logged-model EXPERIMENT_ID" @@ -275,11 +275,11 @@ func newCreateRun() *cobra.Command { cmd.Flags().Var(&createRunJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createRunReq.ExperimentId, "experiment-id", createRunReq.ExperimentId, `ID of the associated experiment.`) - cmd.Flags().StringVar(&createRunReq.RunName, "run-name", createRunReq.RunName, `The name of the run.`) - cmd.Flags().Int64Var(&createRunReq.StartTime, "start-time", createRunReq.StartTime, `Unix timestamp in milliseconds of when the run started.`) + cmd.Flags().StringVar(&createRunReq.ExperimentId, "experiment-id", createRunReq.ExperimentId, `ID of the associated experiment. Wire name: 'experiment_id'.`) + cmd.Flags().StringVar(&createRunReq.RunName, "run-name", createRunReq.RunName, `The name of the run. Wire name: 'run_name'.`) + cmd.Flags().Int64Var(&createRunReq.StartTime, "start-time", createRunReq.StartTime, `Unix timestamp in milliseconds of when the run started. Wire name: 'start_time'.`) // TODO: array: tags - cmd.Flags().StringVar(&createRunReq.UserId, "user-id", createRunReq.UserId, `ID of the user executing the run.`) + cmd.Flags().StringVar(&createRunReq.UserId, "user-id", createRunReq.UserId, `ID of the user executing the run. Wire name: 'user_id'.`) cmd.Use = "create-run" cmd.Short = `Create a run.` @@ -623,7 +623,7 @@ func newDeleteRuns() *cobra.Command { cmd.Flags().Var(&deleteRunsJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().IntVar(&deleteRunsReq.MaxRuns, "max-runs", deleteRunsReq.MaxRuns, `An optional positive integer indicating the maximum number of runs to delete.`) + cmd.Flags().IntVar(&deleteRunsReq.MaxRuns, "max-runs", deleteRunsReq.MaxRuns, `An optional positive integer indicating the maximum number of runs to delete. Wire name: 'max_runs'.`) cmd.Use = "delete-runs EXPERIMENT_ID MAX_TIMESTAMP_MILLIS" cmd.Short = `Delete runs by creation time.` @@ -1006,10 +1006,10 @@ func newGetHistory() *cobra.Command { var getHistoryReq ml.GetHistoryRequest - cmd.Flags().IntVar(&getHistoryReq.MaxResults, "max-results", getHistoryReq.MaxResults, `Maximum number of Metric records to return per paginated request.`) - cmd.Flags().StringVar(&getHistoryReq.PageToken, "page-token", getHistoryReq.PageToken, `Token indicating the page of metric histories to fetch.`) - cmd.Flags().StringVar(&getHistoryReq.RunId, "run-id", getHistoryReq.RunId, `ID of the run from which to fetch metric values.`) - cmd.Flags().StringVar(&getHistoryReq.RunUuid, "run-uuid", getHistoryReq.RunUuid, `[Deprecated, use run_id instead] ID of the run from which to fetch metric values.`) + cmd.Flags().IntVar(&getHistoryReq.MaxResults, "max-results", getHistoryReq.MaxResults, `Maximum number of Metric records to return per paginated request. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&getHistoryReq.PageToken, "page-token", getHistoryReq.PageToken, `Token indicating the page of metric histories to fetch. Wire name: 'page_token'.`) + cmd.Flags().StringVar(&getHistoryReq.RunId, "run-id", getHistoryReq.RunId, `ID of the run from which to fetch metric values. Wire name: 'run_id'.`) + cmd.Flags().StringVar(&getHistoryReq.RunUuid, "run-uuid", getHistoryReq.RunUuid, `[Deprecated, use run_id instead] ID of the run from which to fetch metric values. Wire name: 'run_uuid'.`) cmd.Use = "get-history METRIC_KEY" cmd.Short = `Get metric history for a run.` @@ -1231,7 +1231,7 @@ func newGetRun() *cobra.Command { var getRunReq ml.GetRunRequest - cmd.Flags().StringVar(&getRunReq.RunUuid, "run-uuid", getRunReq.RunUuid, `[Deprecated, use run_id instead] ID of the run to fetch.`) + cmd.Flags().StringVar(&getRunReq.RunUuid, "run-uuid", getRunReq.RunUuid, `[Deprecated, use run_id instead] ID of the run to fetch. Wire name: 'run_uuid'.`) cmd.Use = "get-run RUN_ID" cmd.Short = `Get a run.` @@ -1294,10 +1294,10 @@ func newListArtifacts() *cobra.Command { var listArtifactsReq ml.ListArtifactsRequest - cmd.Flags().StringVar(&listArtifactsReq.PageToken, "page-token", listArtifactsReq.PageToken, `The token indicating the page of artifact results to fetch.`) - cmd.Flags().StringVar(&listArtifactsReq.Path, "path", listArtifactsReq.Path, `Filter artifacts matching this path (a relative path from the root artifact directory).`) - cmd.Flags().StringVar(&listArtifactsReq.RunId, "run-id", listArtifactsReq.RunId, `ID of the run whose artifacts to list.`) - cmd.Flags().StringVar(&listArtifactsReq.RunUuid, "run-uuid", listArtifactsReq.RunUuid, `[Deprecated, use run_id instead] ID of the run whose artifacts to list.`) + cmd.Flags().StringVar(&listArtifactsReq.PageToken, "page-token", listArtifactsReq.PageToken, `The token indicating the page of artifact results to fetch. Wire name: 'page_token'.`) + cmd.Flags().StringVar(&listArtifactsReq.Path, "path", listArtifactsReq.Path, `Filter artifacts matching this path (a relative path from the root artifact directory). Wire name: 'path'.`) + cmd.Flags().StringVar(&listArtifactsReq.RunId, "run-id", listArtifactsReq.RunId, `ID of the run whose artifacts to list. Wire name: 'run_id'.`) + cmd.Flags().StringVar(&listArtifactsReq.RunUuid, "run-uuid", listArtifactsReq.RunUuid, `[Deprecated, use run_id instead] ID of the run whose artifacts to list. Wire name: 'run_uuid'.`) cmd.Use = "list-artifacts" cmd.Short = `List artifacts.` @@ -1352,9 +1352,9 @@ func newListExperiments() *cobra.Command { var listExperimentsReq ml.ListExperimentsRequest - cmd.Flags().Int64Var(&listExperimentsReq.MaxResults, "max-results", listExperimentsReq.MaxResults, `Maximum number of experiments desired.`) - cmd.Flags().StringVar(&listExperimentsReq.PageToken, "page-token", listExperimentsReq.PageToken, `Token indicating the page of experiments to fetch.`) - cmd.Flags().Var(&listExperimentsReq.ViewType, "view-type", `Qualifier for type of experiments to be returned. Supported values: [ACTIVE_ONLY, ALL, DELETED_ONLY]`) + cmd.Flags().Int64Var(&listExperimentsReq.MaxResults, "max-results", listExperimentsReq.MaxResults, `Maximum number of experiments desired. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listExperimentsReq.PageToken, "page-token", listExperimentsReq.PageToken, `Token indicating the page of experiments to fetch. Wire name: 'page_token'.`) + cmd.Flags().Var(&listExperimentsReq.ViewType, "view-type", `Qualifier for type of experiments to be returned. Supported values: [ACTIVE_ONLY, ALL, DELETED_ONLY]. Wire name: 'view_type'.`) cmd.Use = "list-experiments" cmd.Short = `List experiments.` @@ -1409,7 +1409,7 @@ func newLogBatch() *cobra.Command { // TODO: array: metrics // TODO: array: params - cmd.Flags().StringVar(&logBatchReq.RunId, "run-id", logBatchReq.RunId, `ID of the run to log under.`) + cmd.Flags().StringVar(&logBatchReq.RunId, "run-id", logBatchReq.RunId, `ID of the run to log under. Wire name: 'run_id'.`) // TODO: array: tags cmd.Use = "log-batch" @@ -1680,12 +1680,12 @@ func newLogMetric() *cobra.Command { cmd.Flags().Var(&logMetricJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&logMetricReq.DatasetDigest, "dataset-digest", logMetricReq.DatasetDigest, `Dataset digest of the dataset associated with the metric, e.g.`) - cmd.Flags().StringVar(&logMetricReq.DatasetName, "dataset-name", logMetricReq.DatasetName, `The name of the dataset associated with the metric.`) - cmd.Flags().StringVar(&logMetricReq.ModelId, "model-id", logMetricReq.ModelId, `ID of the logged model associated with the metric, if applicable.`) - cmd.Flags().StringVar(&logMetricReq.RunId, "run-id", logMetricReq.RunId, `ID of the run under which to log the metric.`) - cmd.Flags().StringVar(&logMetricReq.RunUuid, "run-uuid", logMetricReq.RunUuid, `[Deprecated, use run_id instead] ID of the run under which to log the metric.`) - cmd.Flags().Int64Var(&logMetricReq.Step, "step", logMetricReq.Step, `Step at which to log the metric.`) + cmd.Flags().StringVar(&logMetricReq.DatasetDigest, "dataset-digest", logMetricReq.DatasetDigest, `Dataset digest of the dataset associated with the metric, e.g. Wire name: 'dataset_digest'.`) + cmd.Flags().StringVar(&logMetricReq.DatasetName, "dataset-name", logMetricReq.DatasetName, `The name of the dataset associated with the metric. Wire name: 'dataset_name'.`) + cmd.Flags().StringVar(&logMetricReq.ModelId, "model-id", logMetricReq.ModelId, `ID of the logged model associated with the metric, if applicable. Wire name: 'model_id'.`) + cmd.Flags().StringVar(&logMetricReq.RunId, "run-id", logMetricReq.RunId, `ID of the run under which to log the metric. Wire name: 'run_id'.`) + cmd.Flags().StringVar(&logMetricReq.RunUuid, "run-uuid", logMetricReq.RunUuid, `[Deprecated, use run_id instead] ID of the run under which to log the metric. Wire name: 'run_uuid'.`) + cmd.Flags().Int64Var(&logMetricReq.Step, "step", logMetricReq.Step, `Step at which to log the metric. Wire name: 'step'.`) cmd.Use = "log-metric KEY VALUE TIMESTAMP" cmd.Short = `Log a metric for a run.` @@ -1785,8 +1785,8 @@ func newLogModel() *cobra.Command { cmd.Flags().Var(&logModelJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&logModelReq.ModelJson, "model-json", logModelReq.ModelJson, `MLmodel file in json format.`) - cmd.Flags().StringVar(&logModelReq.RunId, "run-id", logModelReq.RunId, `ID of the run to log under.`) + cmd.Flags().StringVar(&logModelReq.ModelJson, "model-json", logModelReq.ModelJson, `MLmodel file in json format. Wire name: 'model_json'.`) + cmd.Flags().StringVar(&logModelReq.RunId, "run-id", logModelReq.RunId, `ID of the run to log under. Wire name: 'run_id'.`) cmd.Use = "log-model" cmd.Short = `Log a model.` @@ -1941,8 +1941,8 @@ func newLogParam() *cobra.Command { cmd.Flags().Var(&logParamJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&logParamReq.RunId, "run-id", logParamReq.RunId, `ID of the run under which to log the param.`) - cmd.Flags().StringVar(&logParamReq.RunUuid, "run-uuid", logParamReq.RunUuid, `[Deprecated, use run_id instead] ID of the run under which to log the param.`) + cmd.Flags().StringVar(&logParamReq.RunId, "run-id", logParamReq.RunId, `ID of the run under which to log the param. Wire name: 'run_id'.`) + cmd.Flags().StringVar(&logParamReq.RunUuid, "run-uuid", logParamReq.RunUuid, `[Deprecated, use run_id instead] ID of the run under which to log the param. Wire name: 'run_uuid'.`) cmd.Use = "log-param KEY VALUE" cmd.Short = `Log a param for a run.` @@ -2200,7 +2200,7 @@ func newRestoreRuns() *cobra.Command { cmd.Flags().Var(&restoreRunsJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().IntVar(&restoreRunsReq.MaxRuns, "max-runs", restoreRunsReq.MaxRuns, `An optional positive integer indicating the maximum number of runs to restore.`) + cmd.Flags().IntVar(&restoreRunsReq.MaxRuns, "max-runs", restoreRunsReq.MaxRuns, `An optional positive integer indicating the maximum number of runs to restore. Wire name: 'max_runs'.`) cmd.Use = "restore-runs EXPERIMENT_ID MIN_TIMESTAMP_MILLIS" cmd.Short = `Restore runs by deletion time.` @@ -2294,11 +2294,11 @@ func newSearchExperiments() *cobra.Command { cmd.Flags().Var(&searchExperimentsJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&searchExperimentsReq.Filter, "filter", searchExperimentsReq.Filter, `String representing a SQL filter condition (e.g.`) - cmd.Flags().Int64Var(&searchExperimentsReq.MaxResults, "max-results", searchExperimentsReq.MaxResults, `Maximum number of experiments desired.`) + cmd.Flags().StringVar(&searchExperimentsReq.Filter, "filter", searchExperimentsReq.Filter, `String representing a SQL filter condition (e.g. Wire name: 'filter'.`) + cmd.Flags().Int64Var(&searchExperimentsReq.MaxResults, "max-results", searchExperimentsReq.MaxResults, `Maximum number of experiments desired. Wire name: 'max_results'.`) // TODO: array: order_by - cmd.Flags().StringVar(&searchExperimentsReq.PageToken, "page-token", searchExperimentsReq.PageToken, `Token indicating the page of experiments to fetch.`) - cmd.Flags().Var(&searchExperimentsReq.ViewType, "view-type", `Qualifier for type of experiments to be returned. Supported values: [ACTIVE_ONLY, ALL, DELETED_ONLY]`) + cmd.Flags().StringVar(&searchExperimentsReq.PageToken, "page-token", searchExperimentsReq.PageToken, `Token indicating the page of experiments to fetch. Wire name: 'page_token'.`) + cmd.Flags().Var(&searchExperimentsReq.ViewType, "view-type", `Qualifier for type of experiments to be returned. Supported values: [ACTIVE_ONLY, ALL, DELETED_ONLY]. Wire name: 'view_type'.`) cmd.Use = "search-experiments" cmd.Short = `Search experiments.` @@ -2366,10 +2366,10 @@ func newSearchLoggedModels() *cobra.Command { // TODO: array: datasets // TODO: array: experiment_ids - cmd.Flags().StringVar(&searchLoggedModelsReq.Filter, "filter", searchLoggedModelsReq.Filter, `A filter expression over logged model info and data that allows returning a subset of logged models.`) - cmd.Flags().IntVar(&searchLoggedModelsReq.MaxResults, "max-results", searchLoggedModelsReq.MaxResults, `The maximum number of Logged Models to return.`) + cmd.Flags().StringVar(&searchLoggedModelsReq.Filter, "filter", searchLoggedModelsReq.Filter, `A filter expression over logged model info and data that allows returning a subset of logged models. Wire name: 'filter'.`) + cmd.Flags().IntVar(&searchLoggedModelsReq.MaxResults, "max-results", searchLoggedModelsReq.MaxResults, `The maximum number of Logged Models to return. Wire name: 'max_results'.`) // TODO: array: order_by - cmd.Flags().StringVar(&searchLoggedModelsReq.PageToken, "page-token", searchLoggedModelsReq.PageToken, `The token indicating the page of logged models to fetch.`) + cmd.Flags().StringVar(&searchLoggedModelsReq.PageToken, "page-token", searchLoggedModelsReq.PageToken, `The token indicating the page of logged models to fetch. Wire name: 'page_token'.`) cmd.Use = "search-logged-models" cmd.Short = `Search logged models.` @@ -2439,11 +2439,11 @@ func newSearchRuns() *cobra.Command { cmd.Flags().Var(&searchRunsJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: experiment_ids - cmd.Flags().StringVar(&searchRunsReq.Filter, "filter", searchRunsReq.Filter, `A filter expression over params, metrics, and tags, that allows returning a subset of runs.`) - cmd.Flags().IntVar(&searchRunsReq.MaxResults, "max-results", searchRunsReq.MaxResults, `Maximum number of runs desired.`) + cmd.Flags().StringVar(&searchRunsReq.Filter, "filter", searchRunsReq.Filter, `A filter expression over params, metrics, and tags, that allows returning a subset of runs. Wire name: 'filter'.`) + cmd.Flags().IntVar(&searchRunsReq.MaxResults, "max-results", searchRunsReq.MaxResults, `Maximum number of runs desired. Wire name: 'max_results'.`) // TODO: array: order_by - cmd.Flags().StringVar(&searchRunsReq.PageToken, "page-token", searchRunsReq.PageToken, `Token for the current page of runs.`) - cmd.Flags().Var(&searchRunsReq.RunViewType, "run-view-type", `Whether to display only active, only deleted, or all runs. Supported values: [ACTIVE_ONLY, ALL, DELETED_ONLY]`) + cmd.Flags().StringVar(&searchRunsReq.PageToken, "page-token", searchRunsReq.PageToken, `Token for the current page of runs. Wire name: 'page_token'.`) + cmd.Flags().Var(&searchRunsReq.RunViewType, "run-view-type", `Whether to display only active, only deleted, or all runs. Supported values: [ACTIVE_ONLY, ALL, DELETED_ONLY]. Wire name: 'run_view_type'.`) cmd.Use = "search-runs" cmd.Short = `Search for runs.` @@ -2746,8 +2746,8 @@ func newSetTag() *cobra.Command { cmd.Flags().Var(&setTagJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&setTagReq.RunId, "run-id", setTagReq.RunId, `ID of the run under which to log the tag.`) - cmd.Flags().StringVar(&setTagReq.RunUuid, "run-uuid", setTagReq.RunUuid, `[Deprecated, use run_id instead] ID of the run under which to log the tag.`) + cmd.Flags().StringVar(&setTagReq.RunId, "run-id", setTagReq.RunId, `ID of the run under which to log the tag. Wire name: 'run_id'.`) + cmd.Flags().StringVar(&setTagReq.RunUuid, "run-uuid", setTagReq.RunUuid, `[Deprecated, use run_id instead] ID of the run under which to log the tag. Wire name: 'run_uuid'.`) cmd.Use = "set-tag KEY VALUE" cmd.Short = `Set a tag for a run.` @@ -2835,7 +2835,7 @@ func newUpdateExperiment() *cobra.Command { cmd.Flags().Var(&updateExperimentJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateExperimentReq.NewName, "new-name", updateExperimentReq.NewName, `If provided, the experiment's name is changed to the new name.`) + cmd.Flags().StringVar(&updateExperimentReq.NewName, "new-name", updateExperimentReq.NewName, `If provided, the experiment's name is changed to the new name. Wire name: 'new_name'.`) cmd.Use = "update-experiment EXPERIMENT_ID" cmd.Short = `Update an experiment.` @@ -2991,11 +2991,11 @@ func newUpdateRun() *cobra.Command { cmd.Flags().Var(&updateRunJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().Int64Var(&updateRunReq.EndTime, "end-time", updateRunReq.EndTime, `Unix timestamp in milliseconds of when the run ended.`) - cmd.Flags().StringVar(&updateRunReq.RunId, "run-id", updateRunReq.RunId, `ID of the run to update.`) - cmd.Flags().StringVar(&updateRunReq.RunName, "run-name", updateRunReq.RunName, `Updated name of the run.`) - cmd.Flags().StringVar(&updateRunReq.RunUuid, "run-uuid", updateRunReq.RunUuid, `[Deprecated, use run_id instead] ID of the run to update.`) - cmd.Flags().Var(&updateRunReq.Status, "status", `Updated status of the run. Supported values: [FAILED, FINISHED, KILLED, RUNNING, SCHEDULED]`) + cmd.Flags().Int64Var(&updateRunReq.EndTime, "end-time", updateRunReq.EndTime, `Unix timestamp in milliseconds of when the run ended. Wire name: 'end_time'.`) + cmd.Flags().StringVar(&updateRunReq.RunId, "run-id", updateRunReq.RunId, `ID of the run to update. Wire name: 'run_id'.`) + cmd.Flags().StringVar(&updateRunReq.RunName, "run-name", updateRunReq.RunName, `Updated name of the run. Wire name: 'run_name'.`) + cmd.Flags().StringVar(&updateRunReq.RunUuid, "run-uuid", updateRunReq.RunUuid, `[Deprecated, use run_id instead] ID of the run to update. Wire name: 'run_uuid'.`) + cmd.Flags().Var(&updateRunReq.Status, "status", `Updated status of the run. Supported values: [FAILED, FINISHED, KILLED, RUNNING, SCHEDULED]. Wire name: 'status'.`) cmd.Use = "update-run" cmd.Short = `Update a run.` diff --git a/cmd/workspace/external-lineage/external-lineage.go b/cmd/workspace/external-lineage/external-lineage.go index ea0e7a6ef7..fc22963ef3 100755 --- a/cmd/workspace/external-lineage/external-lineage.go +++ b/cmd/workspace/external-lineage/external-lineage.go @@ -228,8 +228,8 @@ func newListExternalLineageRelationships() *cobra.Command { cmd.Flags().Var(&listExternalLineageRelationshipsJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().IntVar(&listExternalLineageRelationshipsReq.PageSize, "page-size", listExternalLineageRelationshipsReq.PageSize, `Specifies the maximum number of external lineage relationships to return in a single response.`) - cmd.Flags().StringVar(&listExternalLineageRelationshipsReq.PageToken, "page-token", listExternalLineageRelationshipsReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().IntVar(&listExternalLineageRelationshipsReq.PageSize, "page-size", listExternalLineageRelationshipsReq.PageSize, `Specifies the maximum number of external lineage relationships to return in a single response. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listExternalLineageRelationshipsReq.PageToken, "page-token", listExternalLineageRelationshipsReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list-external-lineage-relationships" cmd.Short = `List external lineage relationships.` diff --git a/cmd/workspace/external-locations/external-locations.go b/cmd/workspace/external-locations/external-locations.go index 63c6f4e8c6..e4d40356f4 100755 --- a/cmd/workspace/external-locations/external-locations.go +++ b/cmd/workspace/external-locations/external-locations.go @@ -73,13 +73,13 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `User-provided free-form text description.`) - cmd.Flags().BoolVar(&createReq.EnableFileEvents, "enable-file-events", createReq.EnableFileEvents, `Whether to enable file events on this external location.`) + cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `User-provided free-form text description. Wire name: 'comment'.`) + cmd.Flags().BoolVar(&createReq.EnableFileEvents, "enable-file-events", createReq.EnableFileEvents, `Whether to enable file events on this external location. Wire name: 'enable_file_events'.`) // TODO: complex arg: encryption_details - cmd.Flags().BoolVar(&createReq.Fallback, "fallback", createReq.Fallback, `Indicates whether fallback mode is enabled for this external location.`) + cmd.Flags().BoolVar(&createReq.Fallback, "fallback", createReq.Fallback, `Indicates whether fallback mode is enabled for this external location. Wire name: 'fallback'.`) // TODO: complex arg: file_event_queue - cmd.Flags().BoolVar(&createReq.ReadOnly, "read-only", createReq.ReadOnly, `Indicates whether the external location is read-only.`) - cmd.Flags().BoolVar(&createReq.SkipValidation, "skip-validation", createReq.SkipValidation, `Skips validation of the storage credential associated with the external location.`) + cmd.Flags().BoolVar(&createReq.ReadOnly, "read-only", createReq.ReadOnly, `Indicates whether the external location is read-only. Wire name: 'read_only'.`) + cmd.Flags().BoolVar(&createReq.SkipValidation, "skip-validation", createReq.SkipValidation, `Skips validation of the storage credential associated with the external location. Wire name: 'skip_validation'.`) cmd.Use = "create NAME URL CREDENTIAL_NAME" cmd.Short = `Create an external location.` @@ -168,7 +168,7 @@ func newDelete() *cobra.Command { var deleteReq catalog.DeleteExternalLocationRequest - cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if there are dependent external tables or mounts.`) + cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if there are dependent external tables or mounts. Wire name: 'force'.`) cmd.Use = "delete NAME" cmd.Short = `Delete an external location.` @@ -227,7 +227,7 @@ func newGet() *cobra.Command { var getReq catalog.GetExternalLocationRequest - cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include external locations in the response for which the principal can only access selective metadata for.`) + cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include external locations in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) cmd.Use = "get NAME" cmd.Short = `Get an external location.` @@ -287,10 +287,10 @@ func newList() *cobra.Command { var listReq catalog.ListExternalLocationsRequest - cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include external locations in the response for which the principal can only access selective metadata for.`) - cmd.Flags().BoolVar(&listReq.IncludeUnbound, "include-unbound", listReq.IncludeUnbound, `Whether to include external locations not bound to the workspace.`) - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of external locations to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include external locations in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) + cmd.Flags().BoolVar(&listReq.IncludeUnbound, "include-unbound", listReq.IncludeUnbound, `Whether to include external locations not bound to the workspace. Wire name: 'include_unbound'.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of external locations to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List external locations.` @@ -354,19 +354,19 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `User-provided free-form text description.`) - cmd.Flags().StringVar(&updateReq.CredentialName, "credential-name", updateReq.CredentialName, `Name of the storage credential used with this location.`) - cmd.Flags().BoolVar(&updateReq.EnableFileEvents, "enable-file-events", updateReq.EnableFileEvents, `Whether to enable file events on this external location.`) + cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `User-provided free-form text description. Wire name: 'comment'.`) + cmd.Flags().StringVar(&updateReq.CredentialName, "credential-name", updateReq.CredentialName, `Name of the storage credential used with this location. Wire name: 'credential_name'.`) + cmd.Flags().BoolVar(&updateReq.EnableFileEvents, "enable-file-events", updateReq.EnableFileEvents, `Whether to enable file events on this external location. Wire name: 'enable_file_events'.`) // TODO: complex arg: encryption_details - cmd.Flags().BoolVar(&updateReq.Fallback, "fallback", updateReq.Fallback, `Indicates whether fallback mode is enabled for this external location.`) + cmd.Flags().BoolVar(&updateReq.Fallback, "fallback", updateReq.Fallback, `Indicates whether fallback mode is enabled for this external location. Wire name: 'fallback'.`) // TODO: complex arg: file_event_queue - cmd.Flags().BoolVar(&updateReq.Force, "force", updateReq.Force, `Force update even if changing url invalidates dependent external tables or mounts.`) - cmd.Flags().Var(&updateReq.IsolationMode, "isolation-mode", `Supported values: [ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN]`) - cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the external location.`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `The owner of the external location.`) - cmd.Flags().BoolVar(&updateReq.ReadOnly, "read-only", updateReq.ReadOnly, `Indicates whether the external location is read-only.`) - cmd.Flags().BoolVar(&updateReq.SkipValidation, "skip-validation", updateReq.SkipValidation, `Skips validation of the storage credential associated with the external location.`) - cmd.Flags().StringVar(&updateReq.Url, "url", updateReq.Url, `Path URL of the external location.`) + cmd.Flags().BoolVar(&updateReq.Force, "force", updateReq.Force, `Force update even if changing url invalidates dependent external tables or mounts. Wire name: 'force'.`) + cmd.Flags().Var(&updateReq.IsolationMode, "isolation-mode", `Supported values: [ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN]. Wire name: 'isolation_mode'.`) + cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the external location. Wire name: 'new_name'.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `The owner of the external location. Wire name: 'owner'.`) + cmd.Flags().BoolVar(&updateReq.ReadOnly, "read-only", updateReq.ReadOnly, `Indicates whether the external location is read-only. Wire name: 'read_only'.`) + cmd.Flags().BoolVar(&updateReq.SkipValidation, "skip-validation", updateReq.SkipValidation, `Skips validation of the storage credential associated with the external location. Wire name: 'skip_validation'.`) + cmd.Flags().StringVar(&updateReq.Url, "url", updateReq.Url, `Path URL of the external location. Wire name: 'url'.`) cmd.Use = "update NAME" cmd.Short = `Update an external location.` diff --git a/cmd/workspace/external-metadata/external-metadata.go b/cmd/workspace/external-metadata/external-metadata.go index 0c3cb1211f..7296afbe27 100755 --- a/cmd/workspace/external-metadata/external-metadata.go +++ b/cmd/workspace/external-metadata/external-metadata.go @@ -69,10 +69,10 @@ func newCreateExternalMetadata() *cobra.Command { cmd.Flags().Var(&createExternalMetadataJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: columns - cmd.Flags().StringVar(&createExternalMetadataReq.ExternalMetadata.Description, "description", createExternalMetadataReq.ExternalMetadata.Description, `User-provided free-form text description.`) - cmd.Flags().StringVar(&createExternalMetadataReq.ExternalMetadata.Owner, "owner", createExternalMetadataReq.ExternalMetadata.Owner, `Owner of the external metadata object.`) + cmd.Flags().StringVar(&createExternalMetadataReq.ExternalMetadata.Description, "description", createExternalMetadataReq.ExternalMetadata.Description, `User-provided free-form text description. Wire name: 'description'.`) + cmd.Flags().StringVar(&createExternalMetadataReq.ExternalMetadata.Owner, "owner", createExternalMetadataReq.ExternalMetadata.Owner, `Owner of the external metadata object. Wire name: 'owner'.`) // TODO: map via StringToStringVar: properties - cmd.Flags().StringVar(&createExternalMetadataReq.ExternalMetadata.Url, "url", createExternalMetadataReq.ExternalMetadata.Url, `URL associated with the external metadata object.`) + cmd.Flags().StringVar(&createExternalMetadataReq.ExternalMetadata.Url, "url", createExternalMetadataReq.ExternalMetadata.Url, `URL associated with the external metadata object. Wire name: 'url'.`) cmd.Use = "create-external-metadata NAME SYSTEM_TYPE ENTITY_TYPE" cmd.Short = `Create an external metadata object.` @@ -300,8 +300,8 @@ func newListExternalMetadata() *cobra.Command { var listExternalMetadataReq catalog.ListExternalMetadataRequest - cmd.Flags().IntVar(&listExternalMetadataReq.PageSize, "page-size", listExternalMetadataReq.PageSize, `Specifies the maximum number of external metadata objects to return in a single response.`) - cmd.Flags().StringVar(&listExternalMetadataReq.PageToken, "page-token", listExternalMetadataReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().IntVar(&listExternalMetadataReq.PageSize, "page-size", listExternalMetadataReq.PageSize, `Specifies the maximum number of external metadata objects to return in a single response. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listExternalMetadataReq.PageToken, "page-token", listExternalMetadataReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list-external-metadata" cmd.Short = `List external metadata objects.` @@ -360,10 +360,10 @@ func newUpdateExternalMetadata() *cobra.Command { cmd.Flags().Var(&updateExternalMetadataJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: columns - cmd.Flags().StringVar(&updateExternalMetadataReq.ExternalMetadata.Description, "description", updateExternalMetadataReq.ExternalMetadata.Description, `User-provided free-form text description.`) - cmd.Flags().StringVar(&updateExternalMetadataReq.ExternalMetadata.Owner, "owner", updateExternalMetadataReq.ExternalMetadata.Owner, `Owner of the external metadata object.`) + cmd.Flags().StringVar(&updateExternalMetadataReq.ExternalMetadata.Description, "description", updateExternalMetadataReq.ExternalMetadata.Description, `User-provided free-form text description. Wire name: 'description'.`) + cmd.Flags().StringVar(&updateExternalMetadataReq.ExternalMetadata.Owner, "owner", updateExternalMetadataReq.ExternalMetadata.Owner, `Owner of the external metadata object. Wire name: 'owner'.`) // TODO: map via StringToStringVar: properties - cmd.Flags().StringVar(&updateExternalMetadataReq.ExternalMetadata.Url, "url", updateExternalMetadataReq.ExternalMetadata.Url, `URL associated with the external metadata object.`) + cmd.Flags().StringVar(&updateExternalMetadataReq.ExternalMetadata.Url, "url", updateExternalMetadataReq.ExternalMetadata.Url, `URL associated with the external metadata object. Wire name: 'url'.`) cmd.Use = "update-external-metadata NAME UPDATE_MASK SYSTEM_TYPE ENTITY_TYPE" cmd.Short = `Update an external metadata object.` diff --git a/cmd/workspace/feature-engineering/feature-engineering.go b/cmd/workspace/feature-engineering/feature-engineering.go index 39d003a1f2..cea7cc91a5 100755 --- a/cmd/workspace/feature-engineering/feature-engineering.go +++ b/cmd/workspace/feature-engineering/feature-engineering.go @@ -70,8 +70,8 @@ func newCreateFeature() *cobra.Command { cmd.Flags().Var(&createFeatureJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createFeatureReq.Feature.Description, "description", createFeatureReq.Feature.Description, `The description of the feature.`) - cmd.Flags().StringVar(&createFeatureReq.Feature.FilterCondition, "filter-condition", createFeatureReq.Feature.FilterCondition, `The filter condition applied to the source data before aggregation.`) + cmd.Flags().StringVar(&createFeatureReq.Feature.Description, "description", createFeatureReq.Feature.Description, `The description of the feature. Wire name: 'description'.`) + cmd.Flags().StringVar(&createFeatureReq.Feature.FilterCondition, "filter-condition", createFeatureReq.Feature.FilterCondition, `The filter condition applied to the source data before aggregation. Wire name: 'filter_condition'.`) cmd.Use = "create-feature FULL_NAME SOURCE INPUTS FUNCTION TIME_WINDOW" cmd.Short = `Create a feature.` @@ -188,7 +188,7 @@ func newCreateMaterializedFeature() *cobra.Command { // TODO: complex arg: offline_store_config // TODO: complex arg: online_store_config - cmd.Flags().Var(&createMaterializedFeatureReq.MaterializedFeature.PipelineScheduleState, "pipeline-schedule-state", `The schedule state of the materialization pipeline. Supported values: [ACTIVE, PAUSED, SNAPSHOT]`) + cmd.Flags().Var(&createMaterializedFeatureReq.MaterializedFeature.PipelineScheduleState, "pipeline-schedule-state", `The schedule state of the materialization pipeline. Supported values: [ACTIVE, PAUSED, SNAPSHOT]. Wire name: 'pipeline_schedule_state'.`) cmd.Use = "create-materialized-feature FEATURE_NAME" cmd.Short = `Create a materialized feature.` @@ -485,8 +485,8 @@ func newListFeatures() *cobra.Command { var listFeaturesReq ml.ListFeaturesRequest - cmd.Flags().IntVar(&listFeaturesReq.PageSize, "page-size", listFeaturesReq.PageSize, `The maximum number of results to return.`) - cmd.Flags().StringVar(&listFeaturesReq.PageToken, "page-token", listFeaturesReq.PageToken, `Pagination token to go to the next page based on a previous query.`) + cmd.Flags().IntVar(&listFeaturesReq.PageSize, "page-size", listFeaturesReq.PageSize, `The maximum number of results to return. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listFeaturesReq.PageToken, "page-token", listFeaturesReq.PageToken, `Pagination token to go to the next page based on a previous query. Wire name: 'page_token'.`) cmd.Use = "list-features" cmd.Short = `List features.` @@ -536,9 +536,9 @@ func newListMaterializedFeatures() *cobra.Command { var listMaterializedFeaturesReq ml.ListMaterializedFeaturesRequest - cmd.Flags().StringVar(&listMaterializedFeaturesReq.FeatureName, "feature-name", listMaterializedFeaturesReq.FeatureName, `Filter by feature name.`) - cmd.Flags().IntVar(&listMaterializedFeaturesReq.PageSize, "page-size", listMaterializedFeaturesReq.PageSize, `The maximum number of results to return.`) - cmd.Flags().StringVar(&listMaterializedFeaturesReq.PageToken, "page-token", listMaterializedFeaturesReq.PageToken, `Pagination token to go to the next page based on a previous query.`) + cmd.Flags().StringVar(&listMaterializedFeaturesReq.FeatureName, "feature-name", listMaterializedFeaturesReq.FeatureName, `Filter by feature name. Wire name: 'feature_name'.`) + cmd.Flags().IntVar(&listMaterializedFeaturesReq.PageSize, "page-size", listMaterializedFeaturesReq.PageSize, `The maximum number of results to return. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listMaterializedFeaturesReq.PageToken, "page-token", listMaterializedFeaturesReq.PageToken, `Pagination token to go to the next page based on a previous query. Wire name: 'page_token'.`) cmd.Use = "list-materialized-features" cmd.Short = `List materialized features.` @@ -590,8 +590,8 @@ func newUpdateFeature() *cobra.Command { cmd.Flags().Var(&updateFeatureJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateFeatureReq.Feature.Description, "description", updateFeatureReq.Feature.Description, `The description of the feature.`) - cmd.Flags().StringVar(&updateFeatureReq.Feature.FilterCondition, "filter-condition", updateFeatureReq.Feature.FilterCondition, `The filter condition applied to the source data before aggregation.`) + cmd.Flags().StringVar(&updateFeatureReq.Feature.Description, "description", updateFeatureReq.Feature.Description, `The description of the feature. Wire name: 'description'.`) + cmd.Flags().StringVar(&updateFeatureReq.Feature.FilterCondition, "filter-condition", updateFeatureReq.Feature.FilterCondition, `The filter condition applied to the source data before aggregation. Wire name: 'filter_condition'.`) cmd.Use = "update-feature FULL_NAME UPDATE_MASK SOURCE INPUTS FUNCTION TIME_WINDOW" cmd.Short = `Update a feature's description (all other fields are immutable).` @@ -708,7 +708,7 @@ func newUpdateMaterializedFeature() *cobra.Command { // TODO: complex arg: offline_store_config // TODO: complex arg: online_store_config - cmd.Flags().Var(&updateMaterializedFeatureReq.MaterializedFeature.PipelineScheduleState, "pipeline-schedule-state", `The schedule state of the materialization pipeline. Supported values: [ACTIVE, PAUSED, SNAPSHOT]`) + cmd.Flags().Var(&updateMaterializedFeatureReq.MaterializedFeature.PipelineScheduleState, "pipeline-schedule-state", `The schedule state of the materialization pipeline. Supported values: [ACTIVE, PAUSED, SNAPSHOT]. Wire name: 'pipeline_schedule_state'.`) cmd.Use = "update-materialized-feature MATERIALIZED_FEATURE_ID UPDATE_MASK FEATURE_NAME" cmd.Short = `Update a materialized feature.` diff --git a/cmd/workspace/feature-store/feature-store.go b/cmd/workspace/feature-store/feature-store.go index 00bb904df1..008cd6cf91 100755 --- a/cmd/workspace/feature-store/feature-store.go +++ b/cmd/workspace/feature-store/feature-store.go @@ -72,7 +72,7 @@ func newCreateOnlineStore() *cobra.Command { cmd.Flags().Var(&createOnlineStoreJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().IntVar(&createOnlineStoreReq.OnlineStore.ReadReplicaCount, "read-replica-count", createOnlineStoreReq.OnlineStore.ReadReplicaCount, `The number of read replicas for the online store.`) + cmd.Flags().IntVar(&createOnlineStoreReq.OnlineStore.ReadReplicaCount, "read-replica-count", createOnlineStoreReq.OnlineStore.ReadReplicaCount, `The number of read replicas for the online store. Wire name: 'read_replica_count'.`) cmd.Use = "create-online-store NAME CAPACITY" cmd.Short = `Create an Online Feature Store.` @@ -263,8 +263,8 @@ func newListOnlineStores() *cobra.Command { var listOnlineStoresReq ml.ListOnlineStoresRequest - cmd.Flags().IntVar(&listOnlineStoresReq.PageSize, "page-size", listOnlineStoresReq.PageSize, `The maximum number of results to return.`) - cmd.Flags().StringVar(&listOnlineStoresReq.PageToken, "page-token", listOnlineStoresReq.PageToken, `Pagination token to go to the next page based on a previous query.`) + cmd.Flags().IntVar(&listOnlineStoresReq.PageSize, "page-size", listOnlineStoresReq.PageSize, `The maximum number of results to return. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listOnlineStoresReq.PageToken, "page-token", listOnlineStoresReq.PageToken, `Pagination token to go to the next page based on a previous query. Wire name: 'page_token'.`) cmd.Use = "list-online-stores" cmd.Short = `List Online Feature Stores.` @@ -387,7 +387,7 @@ func newUpdateOnlineStore() *cobra.Command { cmd.Flags().Var(&updateOnlineStoreJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().IntVar(&updateOnlineStoreReq.OnlineStore.ReadReplicaCount, "read-replica-count", updateOnlineStoreReq.OnlineStore.ReadReplicaCount, `The number of read replicas for the online store.`) + cmd.Flags().IntVar(&updateOnlineStoreReq.OnlineStore.ReadReplicaCount, "read-replica-count", updateOnlineStoreReq.OnlineStore.ReadReplicaCount, `The number of read replicas for the online store. Wire name: 'read_replica_count'.`) cmd.Use = "update-online-store NAME UPDATE_MASK CAPACITY" cmd.Short = `Update an Online Feature Store.` diff --git a/cmd/workspace/forecasting/forecasting.go b/cmd/workspace/forecasting/forecasting.go index 188a2709fe..13b178c938 100755 --- a/cmd/workspace/forecasting/forecasting.go +++ b/cmd/workspace/forecasting/forecasting.go @@ -69,16 +69,16 @@ func newCreateExperiment() *cobra.Command { cmd.Flags().Var(&createExperimentJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createExperimentReq.CustomWeightsColumn, "custom-weights-column", createExperimentReq.CustomWeightsColumn, `The column in the training table used to customize weights for each time series.`) - cmd.Flags().StringVar(&createExperimentReq.ExperimentPath, "experiment-path", createExperimentReq.ExperimentPath, `The path in the workspace to store the created experiment.`) - cmd.Flags().StringVar(&createExperimentReq.FutureFeatureDataPath, "future-feature-data-path", createExperimentReq.FutureFeatureDataPath, `The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used to store future feature data for predictions.`) + cmd.Flags().StringVar(&createExperimentReq.CustomWeightsColumn, "custom-weights-column", createExperimentReq.CustomWeightsColumn, `The column in the training table used to customize weights for each time series. Wire name: 'custom_weights_column'.`) + cmd.Flags().StringVar(&createExperimentReq.ExperimentPath, "experiment-path", createExperimentReq.ExperimentPath, `The path in the workspace to store the created experiment. Wire name: 'experiment_path'.`) + cmd.Flags().StringVar(&createExperimentReq.FutureFeatureDataPath, "future-feature-data-path", createExperimentReq.FutureFeatureDataPath, `The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used to store future feature data for predictions. Wire name: 'future_feature_data_path'.`) // TODO: array: holiday_regions // TODO: array: include_features - cmd.Flags().Int64Var(&createExperimentReq.MaxRuntime, "max-runtime", createExperimentReq.MaxRuntime, `The maximum duration for the experiment in minutes.`) - cmd.Flags().StringVar(&createExperimentReq.PredictionDataPath, "prediction-data-path", createExperimentReq.PredictionDataPath, `The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used to store predictions.`) - cmd.Flags().StringVar(&createExperimentReq.PrimaryMetric, "primary-metric", createExperimentReq.PrimaryMetric, `The evaluation metric used to optimize the forecasting model.`) - cmd.Flags().StringVar(&createExperimentReq.RegisterTo, "register-to", createExperimentReq.RegisterTo, `The fully qualified path of a Unity Catalog model, formatted as catalog_name.schema_name.model_name, used to store the best model.`) - cmd.Flags().StringVar(&createExperimentReq.SplitColumn, "split-column", createExperimentReq.SplitColumn, `// The column in the training table used for custom data splits.`) + cmd.Flags().Int64Var(&createExperimentReq.MaxRuntime, "max-runtime", createExperimentReq.MaxRuntime, `The maximum duration for the experiment in minutes. Wire name: 'max_runtime'.`) + cmd.Flags().StringVar(&createExperimentReq.PredictionDataPath, "prediction-data-path", createExperimentReq.PredictionDataPath, `The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used to store predictions. Wire name: 'prediction_data_path'.`) + cmd.Flags().StringVar(&createExperimentReq.PrimaryMetric, "primary-metric", createExperimentReq.PrimaryMetric, `The evaluation metric used to optimize the forecasting model. Wire name: 'primary_metric'.`) + cmd.Flags().StringVar(&createExperimentReq.RegisterTo, "register-to", createExperimentReq.RegisterTo, `The fully qualified path of a Unity Catalog model, formatted as catalog_name.schema_name.model_name, used to store the best model. Wire name: 'register_to'.`) + cmd.Flags().StringVar(&createExperimentReq.SplitColumn, "split-column", createExperimentReq.SplitColumn, `// The column in the training table used for custom data splits. Wire name: 'split_column'.`) // TODO: array: timeseries_identifier_columns // TODO: array: training_frameworks diff --git a/cmd/workspace/functions/functions.go b/cmd/workspace/functions/functions.go index 078a168b96..cbe17a1727 100755 --- a/cmd/workspace/functions/functions.go +++ b/cmd/workspace/functions/functions.go @@ -133,7 +133,7 @@ func newDelete() *cobra.Command { var deleteReq catalog.DeleteFunctionRequest - cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the function is notempty.`) + cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the function is notempty. Wire name: 'force'.`) cmd.Use = "delete NAME" cmd.Short = `Delete a function.` @@ -209,7 +209,7 @@ func newGet() *cobra.Command { var getReq catalog.GetFunctionRequest - cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include functions in the response for which the principal can only access selective metadata for.`) + cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include functions in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) cmd.Use = "get NAME" cmd.Short = `Get a function.` @@ -286,9 +286,9 @@ func newList() *cobra.Command { var listReq catalog.ListFunctionsRequest - cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include functions in the response for which the principal can only access selective metadata for.`) - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of functions to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include functions in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of functions to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list CATALOG_NAME SCHEMA_NAME" cmd.Short = `List functions.` @@ -362,7 +362,7 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of the function.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of the function. Wire name: 'owner'.`) cmd.Use = "update NAME" cmd.Short = `Update a function.` diff --git a/cmd/workspace/genie/genie.go b/cmd/workspace/genie/genie.go index ce6e01279b..67b5796a94 100755 --- a/cmd/workspace/genie/genie.go +++ b/cmd/workspace/genie/genie.go @@ -736,8 +736,8 @@ func newListConversationMessages() *cobra.Command { var listConversationMessagesReq dashboards.GenieListConversationMessagesRequest - cmd.Flags().IntVar(&listConversationMessagesReq.PageSize, "page-size", listConversationMessagesReq.PageSize, `Maximum number of messages to return per page.`) - cmd.Flags().StringVar(&listConversationMessagesReq.PageToken, "page-token", listConversationMessagesReq.PageToken, `Token to get the next page of results.`) + cmd.Flags().IntVar(&listConversationMessagesReq.PageSize, "page-size", listConversationMessagesReq.PageSize, `Maximum number of messages to return per page. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listConversationMessagesReq.PageToken, "page-token", listConversationMessagesReq.PageToken, `Token to get the next page of results. Wire name: 'page_token'.`) cmd.Use = "list-conversation-messages SPACE_ID CONVERSATION_ID" cmd.Short = `List conversation messages.` @@ -797,9 +797,9 @@ func newListConversations() *cobra.Command { var listConversationsReq dashboards.GenieListConversationsRequest - cmd.Flags().BoolVar(&listConversationsReq.IncludeAll, "include-all", listConversationsReq.IncludeAll, `Include all conversations in the space across all users.`) - cmd.Flags().IntVar(&listConversationsReq.PageSize, "page-size", listConversationsReq.PageSize, `Maximum number of conversations to return per page.`) - cmd.Flags().StringVar(&listConversationsReq.PageToken, "page-token", listConversationsReq.PageToken, `Token to get the next page of results.`) + cmd.Flags().BoolVar(&listConversationsReq.IncludeAll, "include-all", listConversationsReq.IncludeAll, `Include all conversations in the space across all users. Wire name: 'include_all'.`) + cmd.Flags().IntVar(&listConversationsReq.PageSize, "page-size", listConversationsReq.PageSize, `Maximum number of conversations to return per page. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listConversationsReq.PageToken, "page-token", listConversationsReq.PageToken, `Token to get the next page of results. Wire name: 'page_token'.`) cmd.Use = "list-conversations SPACE_ID" cmd.Short = `List conversations in a Genie Space.` @@ -857,8 +857,8 @@ func newListSpaces() *cobra.Command { var listSpacesReq dashboards.GenieListSpacesRequest - cmd.Flags().IntVar(&listSpacesReq.PageSize, "page-size", listSpacesReq.PageSize, `Maximum number of spaces to return per page.`) - cmd.Flags().StringVar(&listSpacesReq.PageToken, "page-token", listSpacesReq.PageToken, `Pagination token for getting the next page of results.`) + cmd.Flags().IntVar(&listSpacesReq.PageSize, "page-size", listSpacesReq.PageSize, `Maximum number of spaces to return per page. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listSpacesReq.PageToken, "page-token", listSpacesReq.PageToken, `Pagination token for getting the next page of results. Wire name: 'page_token'.`) cmd.Use = "list-spaces" cmd.Short = `List Genie spaces.` diff --git a/cmd/workspace/git-credentials/git-credentials.go b/cmd/workspace/git-credentials/git-credentials.go index 02b60cc2e6..7ee7041b01 100755 --- a/cmd/workspace/git-credentials/git-credentials.go +++ b/cmd/workspace/git-credentials/git-credentials.go @@ -66,11 +66,11 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.GitEmail, "git-email", createReq.GitEmail, `The authenticating email associated with your Git provider user account.`) - cmd.Flags().StringVar(&createReq.GitUsername, "git-username", createReq.GitUsername, `The username provided with your Git provider account and associated with the credential.`) - cmd.Flags().BoolVar(&createReq.IsDefaultForProvider, "is-default-for-provider", createReq.IsDefaultForProvider, `if the credential is the default for the given provider.`) - cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `the name of the git credential, used for identification and ease of lookup.`) - cmd.Flags().StringVar(&createReq.PersonalAccessToken, "personal-access-token", createReq.PersonalAccessToken, `The personal access token used to authenticate to the corresponding Git provider.`) + cmd.Flags().StringVar(&createReq.GitEmail, "git-email", createReq.GitEmail, `The authenticating email associated with your Git provider user account. Wire name: 'git_email'.`) + cmd.Flags().StringVar(&createReq.GitUsername, "git-username", createReq.GitUsername, `The username provided with your Git provider account and associated with the credential. Wire name: 'git_username'.`) + cmd.Flags().BoolVar(&createReq.IsDefaultForProvider, "is-default-for-provider", createReq.IsDefaultForProvider, `if the credential is the default for the given provider. Wire name: 'is_default_for_provider'.`) + cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `the name of the git credential, used for identification and ease of lookup. Wire name: 'name'.`) + cmd.Flags().StringVar(&createReq.PersonalAccessToken, "personal-access-token", createReq.PersonalAccessToken, `The personal access token used to authenticate to the corresponding Git provider. Wire name: 'personal_access_token'.`) cmd.Use = "create GIT_PROVIDER" cmd.Short = `Create a credential entry.` @@ -340,11 +340,11 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.GitEmail, "git-email", updateReq.GitEmail, `The authenticating email associated with your Git provider user account.`) - cmd.Flags().StringVar(&updateReq.GitUsername, "git-username", updateReq.GitUsername, `The username provided with your Git provider account and associated with the credential.`) - cmd.Flags().BoolVar(&updateReq.IsDefaultForProvider, "is-default-for-provider", updateReq.IsDefaultForProvider, `if the credential is the default for the given provider.`) - cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `the name of the git credential, used for identification and ease of lookup.`) - cmd.Flags().StringVar(&updateReq.PersonalAccessToken, "personal-access-token", updateReq.PersonalAccessToken, `The personal access token used to authenticate to the corresponding Git provider.`) + cmd.Flags().StringVar(&updateReq.GitEmail, "git-email", updateReq.GitEmail, `The authenticating email associated with your Git provider user account. Wire name: 'git_email'.`) + cmd.Flags().StringVar(&updateReq.GitUsername, "git-username", updateReq.GitUsername, `The username provided with your Git provider account and associated with the credential. Wire name: 'git_username'.`) + cmd.Flags().BoolVar(&updateReq.IsDefaultForProvider, "is-default-for-provider", updateReq.IsDefaultForProvider, `if the credential is the default for the given provider. Wire name: 'is_default_for_provider'.`) + cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `the name of the git credential, used for identification and ease of lookup. Wire name: 'name'.`) + cmd.Flags().StringVar(&updateReq.PersonalAccessToken, "personal-access-token", updateReq.PersonalAccessToken, `The personal access token used to authenticate to the corresponding Git provider. Wire name: 'personal_access_token'.`) cmd.Use = "update CREDENTIAL_ID GIT_PROVIDER" cmd.Short = `Update a credential.` diff --git a/cmd/workspace/global-init-scripts/global-init-scripts.go b/cmd/workspace/global-init-scripts/global-init-scripts.go index ed20214985..9caf26e3aa 100755 --- a/cmd/workspace/global-init-scripts/global-init-scripts.go +++ b/cmd/workspace/global-init-scripts/global-init-scripts.go @@ -69,8 +69,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&createReq.Enabled, "enabled", createReq.Enabled, `Specifies whether the script is enabled.`) - cmd.Flags().IntVar(&createReq.Position, "position", createReq.Position, `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.`) + cmd.Flags().BoolVar(&createReq.Enabled, "enabled", createReq.Enabled, `Specifies whether the script is enabled. Wire name: 'enabled'.`) + cmd.Flags().IntVar(&createReq.Position, "position", createReq.Position, `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. Wire name: 'position'.`) cmd.Use = "create NAME SCRIPT" cmd.Short = `Create init script.` @@ -334,8 +334,8 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&updateReq.Enabled, "enabled", updateReq.Enabled, `Specifies whether the script is enabled.`) - cmd.Flags().IntVar(&updateReq.Position, "position", updateReq.Position, `The position of a script, where 0 represents the first script to run, 1 is the second script to run, in ascending order.`) + cmd.Flags().BoolVar(&updateReq.Enabled, "enabled", updateReq.Enabled, `Specifies whether the script is enabled. Wire name: 'enabled'.`) + cmd.Flags().IntVar(&updateReq.Position, "position", updateReq.Position, `The position of a script, where 0 represents the first script to run, 1 is the second script to run, in ascending order. Wire name: 'position'.`) cmd.Use = "update SCRIPT_ID NAME SCRIPT" cmd.Short = `Update init script.` diff --git a/cmd/workspace/grants/grants.go b/cmd/workspace/grants/grants.go index fef4b74614..4c3bb33801 100755 --- a/cmd/workspace/grants/grants.go +++ b/cmd/workspace/grants/grants.go @@ -64,9 +64,9 @@ func newGet() *cobra.Command { var getReq catalog.GetGrantRequest - cmd.Flags().IntVar(&getReq.MaxResults, "max-results", getReq.MaxResults, `Specifies the maximum number of privileges to return (page length).`) - cmd.Flags().StringVar(&getReq.PageToken, "page-token", getReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) - cmd.Flags().StringVar(&getReq.Principal, "principal", getReq.Principal, `If provided, only the permissions for the specified principal (user or group) are returned.`) + cmd.Flags().IntVar(&getReq.MaxResults, "max-results", getReq.MaxResults, `Specifies the maximum number of privileges to return (page length). Wire name: 'max_results'.`) + cmd.Flags().StringVar(&getReq.PageToken, "page-token", getReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) + cmd.Flags().StringVar(&getReq.Principal, "principal", getReq.Principal, `If provided, only the permissions for the specified principal (user or group) are returned. Wire name: 'principal'.`) cmd.Use = "get SECURABLE_TYPE FULL_NAME" cmd.Short = `Get permissions.` @@ -134,9 +134,9 @@ func newGetEffective() *cobra.Command { var getEffectiveReq catalog.GetEffectiveRequest - cmd.Flags().IntVar(&getEffectiveReq.MaxResults, "max-results", getEffectiveReq.MaxResults, `Specifies the maximum number of privileges to return (page length).`) - cmd.Flags().StringVar(&getEffectiveReq.PageToken, "page-token", getEffectiveReq.PageToken, `Opaque token for the next page of results (pagination).`) - cmd.Flags().StringVar(&getEffectiveReq.Principal, "principal", getEffectiveReq.Principal, `If provided, only the effective permissions for the specified principal (user or group) are returned.`) + cmd.Flags().IntVar(&getEffectiveReq.MaxResults, "max-results", getEffectiveReq.MaxResults, `Specifies the maximum number of privileges to return (page length). Wire name: 'max_results'.`) + cmd.Flags().StringVar(&getEffectiveReq.PageToken, "page-token", getEffectiveReq.PageToken, `Opaque token for the next page of results (pagination). Wire name: 'page_token'.`) + cmd.Flags().StringVar(&getEffectiveReq.Principal, "principal", getEffectiveReq.Principal, `If provided, only the effective permissions for the specified principal (user or group) are returned. Wire name: 'principal'.`) cmd.Use = "get-effective SECURABLE_TYPE FULL_NAME" cmd.Short = `Get effective permissions.` diff --git a/cmd/workspace/groups-v2/groups-v2.go b/cmd/workspace/groups-v2/groups-v2.go index 580e5d1952..cde3de4d3a 100755 --- a/cmd/workspace/groups-v2/groups-v2.go +++ b/cmd/workspace/groups-v2/groups-v2.go @@ -66,11 +66,11 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `String that represents a human-readable group name.`) + cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `String that represents a human-readable group name. Wire name: 'displayName'.`) // TODO: array: entitlements - cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, ``) + cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, `Wire name: 'externalId'.`) // TODO: array: groups - cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks group ID.`) + cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks group ID. Wire name: 'id'.`) // TODO: array: members // TODO: complex arg: meta // TODO: array: roles @@ -253,13 +253,13 @@ func newList() *cobra.Command { var listReq iam.ListGroupsRequest - cmd.Flags().StringVar(&listReq.Attributes, "attributes", listReq.Attributes, `Comma-separated list of attributes to return in response.`) - cmd.Flags().Int64Var(&listReq.Count, "count", listReq.Count, `Desired number of results per page.`) - cmd.Flags().StringVar(&listReq.ExcludedAttributes, "excluded-attributes", listReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response.`) - cmd.Flags().StringVar(&listReq.Filter, "filter", listReq.Filter, `Query by which the results have to be filtered.`) - cmd.Flags().StringVar(&listReq.SortBy, "sort-by", listReq.SortBy, `Attribute to sort the results.`) - cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]`) - cmd.Flags().Int64Var(&listReq.StartIndex, "start-index", listReq.StartIndex, `Specifies the index of the first result.`) + cmd.Flags().StringVar(&listReq.Attributes, "attributes", listReq.Attributes, `Comma-separated list of attributes to return in response. Wire name: 'attributes'.`) + cmd.Flags().Int64Var(&listReq.Count, "count", listReq.Count, `Desired number of results per page. Wire name: 'count'.`) + cmd.Flags().StringVar(&listReq.ExcludedAttributes, "excluded-attributes", listReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response. Wire name: 'excludedAttributes'.`) + cmd.Flags().StringVar(&listReq.Filter, "filter", listReq.Filter, `Query by which the results have to be filtered. Wire name: 'filter'.`) + cmd.Flags().StringVar(&listReq.SortBy, "sort-by", listReq.SortBy, `Attribute to sort the results. Wire name: 'sortBy'.`) + cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]. Wire name: 'sortOrder'.`) + cmd.Flags().Int64Var(&listReq.StartIndex, "start-index", listReq.StartIndex, `Specifies the index of the first result. Wire name: 'startIndex'.`) cmd.Use = "list" cmd.Short = `List group details.` @@ -386,9 +386,9 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `String that represents a human-readable group name.`) + cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `String that represents a human-readable group name. Wire name: 'displayName'.`) // TODO: array: entitlements - cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, ``) + cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, `Wire name: 'externalId'.`) // TODO: array: groups // TODO: array: members // TODO: complex arg: meta diff --git a/cmd/workspace/instance-pools/instance-pools.go b/cmd/workspace/instance-pools/instance-pools.go index 7e6d69b320..24e811729a 100755 --- a/cmd/workspace/instance-pools/instance-pools.go +++ b/cmd/workspace/instance-pools/instance-pools.go @@ -86,15 +86,15 @@ func newCreate() *cobra.Command { // TODO: complex arg: azure_attributes // TODO: map via StringToStringVar: custom_tags // TODO: complex arg: disk_spec - cmd.Flags().BoolVar(&createReq.EnableElasticDisk, "enable-elastic-disk", createReq.EnableElasticDisk, `Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire additional disk space when its Spark workers are running low on disk space.`) + cmd.Flags().BoolVar(&createReq.EnableElasticDisk, "enable-elastic-disk", createReq.EnableElasticDisk, `Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire additional disk space when its Spark workers are running low on disk space. Wire name: 'enable_elastic_disk'.`) // TODO: complex arg: gcp_attributes - cmd.Flags().IntVar(&createReq.IdleInstanceAutoterminationMinutes, "idle-instance-autotermination-minutes", createReq.IdleInstanceAutoterminationMinutes, `Automatically terminates the extra instances in the pool cache after they are inactive for this time in minutes if min_idle_instances requirement is already met.`) - cmd.Flags().IntVar(&createReq.MaxCapacity, "max-capacity", createReq.MaxCapacity, `Maximum number of outstanding instances to keep in the pool, including both instances used by clusters and idle instances.`) - cmd.Flags().IntVar(&createReq.MinIdleInstances, "min-idle-instances", createReq.MinIdleInstances, `Minimum number of idle instances to keep in the instance pool.`) + cmd.Flags().IntVar(&createReq.IdleInstanceAutoterminationMinutes, "idle-instance-autotermination-minutes", createReq.IdleInstanceAutoterminationMinutes, `Automatically terminates the extra instances in the pool cache after they are inactive for this time in minutes if min_idle_instances requirement is already met. Wire name: 'idle_instance_autotermination_minutes'.`) + cmd.Flags().IntVar(&createReq.MaxCapacity, "max-capacity", createReq.MaxCapacity, `Maximum number of outstanding instances to keep in the pool, including both instances used by clusters and idle instances. Wire name: 'max_capacity'.`) + cmd.Flags().IntVar(&createReq.MinIdleInstances, "min-idle-instances", createReq.MinIdleInstances, `Minimum number of idle instances to keep in the instance pool. Wire name: 'min_idle_instances'.`) // TODO: array: preloaded_docker_images // TODO: array: preloaded_spark_versions - cmd.Flags().IntVar(&createReq.RemoteDiskThroughput, "remote-disk-throughput", createReq.RemoteDiskThroughput, `If set, what the configurable throughput (in Mb/s) for the remote disk is.`) - cmd.Flags().IntVar(&createReq.TotalInitialRemoteDiskSize, "total-initial-remote-disk-size", createReq.TotalInitialRemoteDiskSize, `If set, what the total initial volume size (in GB) of the remote disks should be.`) + cmd.Flags().IntVar(&createReq.RemoteDiskThroughput, "remote-disk-throughput", createReq.RemoteDiskThroughput, `If set, what the configurable throughput (in Mb/s) for the remote disk is. Wire name: 'remote_disk_throughput'.`) + cmd.Flags().IntVar(&createReq.TotalInitialRemoteDiskSize, "total-initial-remote-disk-size", createReq.TotalInitialRemoteDiskSize, `If set, what the total initial volume size (in GB) of the remote disks should be. Wire name: 'total_initial_remote_disk_size'.`) cmd.Use = "create INSTANCE_POOL_NAME NODE_TYPE_ID" cmd.Short = `Create a new instance pool.` @@ -282,11 +282,11 @@ func newEdit() *cobra.Command { cmd.Flags().Var(&editJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: map via StringToStringVar: custom_tags - cmd.Flags().IntVar(&editReq.IdleInstanceAutoterminationMinutes, "idle-instance-autotermination-minutes", editReq.IdleInstanceAutoterminationMinutes, `Automatically terminates the extra instances in the pool cache after they are inactive for this time in minutes if min_idle_instances requirement is already met.`) - cmd.Flags().IntVar(&editReq.MaxCapacity, "max-capacity", editReq.MaxCapacity, `Maximum number of outstanding instances to keep in the pool, including both instances used by clusters and idle instances.`) - cmd.Flags().IntVar(&editReq.MinIdleInstances, "min-idle-instances", editReq.MinIdleInstances, `Minimum number of idle instances to keep in the instance pool.`) - cmd.Flags().IntVar(&editReq.RemoteDiskThroughput, "remote-disk-throughput", editReq.RemoteDiskThroughput, `If set, what the configurable throughput (in Mb/s) for the remote disk is.`) - cmd.Flags().IntVar(&editReq.TotalInitialRemoteDiskSize, "total-initial-remote-disk-size", editReq.TotalInitialRemoteDiskSize, `If set, what the total initial volume size (in GB) of the remote disks should be.`) + cmd.Flags().IntVar(&editReq.IdleInstanceAutoterminationMinutes, "idle-instance-autotermination-minutes", editReq.IdleInstanceAutoterminationMinutes, `Automatically terminates the extra instances in the pool cache after they are inactive for this time in minutes if min_idle_instances requirement is already met. Wire name: 'idle_instance_autotermination_minutes'.`) + cmd.Flags().IntVar(&editReq.MaxCapacity, "max-capacity", editReq.MaxCapacity, `Maximum number of outstanding instances to keep in the pool, including both instances used by clusters and idle instances. Wire name: 'max_capacity'.`) + cmd.Flags().IntVar(&editReq.MinIdleInstances, "min-idle-instances", editReq.MinIdleInstances, `Minimum number of idle instances to keep in the instance pool. Wire name: 'min_idle_instances'.`) + cmd.Flags().IntVar(&editReq.RemoteDiskThroughput, "remote-disk-throughput", editReq.RemoteDiskThroughput, `If set, what the configurable throughput (in Mb/s) for the remote disk is. Wire name: 'remote_disk_throughput'.`) + cmd.Flags().IntVar(&editReq.TotalInitialRemoteDiskSize, "total-initial-remote-disk-size", editReq.TotalInitialRemoteDiskSize, `If set, what the total initial volume size (in GB) of the remote disks should be. Wire name: 'total_initial_remote_disk_size'.`) cmd.Use = "edit INSTANCE_POOL_ID INSTANCE_POOL_NAME NODE_TYPE_ID" cmd.Short = `Edit an existing instance pool.` diff --git a/cmd/workspace/instance-profiles/instance-profiles.go b/cmd/workspace/instance-profiles/instance-profiles.go index dfbefe934f..7c9e150c0c 100755 --- a/cmd/workspace/instance-profiles/instance-profiles.go +++ b/cmd/workspace/instance-profiles/instance-profiles.go @@ -65,9 +65,9 @@ func newAdd() *cobra.Command { cmd.Flags().Var(&addJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&addReq.IamRoleArn, "iam-role-arn", addReq.IamRoleArn, `The AWS IAM role ARN of the role associated with the instance profile.`) - cmd.Flags().BoolVar(&addReq.IsMetaInstanceProfile, "is-meta-instance-profile", addReq.IsMetaInstanceProfile, `Boolean flag indicating whether the instance profile should only be used in credential passthrough scenarios.`) - cmd.Flags().BoolVar(&addReq.SkipValidation, "skip-validation", addReq.SkipValidation, `By default, Databricks validates that it has sufficient permissions to launch instances with the instance profile.`) + cmd.Flags().StringVar(&addReq.IamRoleArn, "iam-role-arn", addReq.IamRoleArn, `The AWS IAM role ARN of the role associated with the instance profile. Wire name: 'iam_role_arn'.`) + cmd.Flags().BoolVar(&addReq.IsMetaInstanceProfile, "is-meta-instance-profile", addReq.IsMetaInstanceProfile, `Boolean flag indicating whether the instance profile should only be used in credential passthrough scenarios. Wire name: 'is_meta_instance_profile'.`) + cmd.Flags().BoolVar(&addReq.SkipValidation, "skip-validation", addReq.SkipValidation, `By default, Databricks validates that it has sufficient permissions to launch instances with the instance profile. Wire name: 'skip_validation'.`) cmd.Use = "add INSTANCE_PROFILE_ARN" cmd.Short = `Register an instance profile.` @@ -153,8 +153,8 @@ func newEdit() *cobra.Command { cmd.Flags().Var(&editJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&editReq.IamRoleArn, "iam-role-arn", editReq.IamRoleArn, `The AWS IAM role ARN of the role associated with the instance profile.`) - cmd.Flags().BoolVar(&editReq.IsMetaInstanceProfile, "is-meta-instance-profile", editReq.IsMetaInstanceProfile, `Boolean flag indicating whether the instance profile should only be used in credential passthrough scenarios.`) + cmd.Flags().StringVar(&editReq.IamRoleArn, "iam-role-arn", editReq.IamRoleArn, `The AWS IAM role ARN of the role associated with the instance profile. Wire name: 'iam_role_arn'.`) + cmd.Flags().BoolVar(&editReq.IsMetaInstanceProfile, "is-meta-instance-profile", editReq.IsMetaInstanceProfile, `Boolean flag indicating whether the instance profile should only be used in credential passthrough scenarios. Wire name: 'is_meta_instance_profile'.`) cmd.Use = "edit INSTANCE_PROFILE_ARN" cmd.Short = `Edit an instance profile.` diff --git a/cmd/workspace/ip-access-lists/ip-access-lists.go b/cmd/workspace/ip-access-lists/ip-access-lists.go index d29d7b98c4..6f1c131a8f 100755 --- a/cmd/workspace/ip-access-lists/ip-access-lists.go +++ b/cmd/workspace/ip-access-lists/ip-access-lists.go @@ -475,10 +475,10 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&updateReq.Enabled, "enabled", updateReq.Enabled, `Specifies whether this IP access list is enabled.`) + cmd.Flags().BoolVar(&updateReq.Enabled, "enabled", updateReq.Enabled, `Specifies whether this IP access list is enabled. Wire name: 'enabled'.`) // TODO: array: ip_addresses - cmd.Flags().StringVar(&updateReq.Label, "label", updateReq.Label, `Label for the IP access list.`) - cmd.Flags().Var(&updateReq.ListType, "list-type", `Supported values: [ALLOW, BLOCK]`) + cmd.Flags().StringVar(&updateReq.Label, "label", updateReq.Label, `Label for the IP access list. Wire name: 'label'.`) + cmd.Flags().Var(&updateReq.ListType, "list-type", `Supported values: [ALLOW, BLOCK]. Wire name: 'list_type'.`) cmd.Use = "update IP_ACCESS_LIST_ID" cmd.Short = `Update access list.` diff --git a/cmd/workspace/jobs/jobs.go b/cmd/workspace/jobs/jobs.go index 6a6ae772b2..164d5f49f6 100755 --- a/cmd/workspace/jobs/jobs.go +++ b/cmd/workspace/jobs/jobs.go @@ -94,8 +94,8 @@ func newCancelAllRuns() *cobra.Command { cmd.Flags().Var(&cancelAllRunsJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&cancelAllRunsReq.AllQueuedRuns, "all-queued-runs", cancelAllRunsReq.AllQueuedRuns, `Optional boolean parameter to cancel all queued runs.`) - cmd.Flags().Int64Var(&cancelAllRunsReq.JobId, "job-id", cancelAllRunsReq.JobId, `The canonical identifier of the job to cancel all runs of.`) + cmd.Flags().BoolVar(&cancelAllRunsReq.AllQueuedRuns, "all-queued-runs", cancelAllRunsReq.AllQueuedRuns, `Optional boolean parameter to cancel all queued runs. Wire name: 'all_queued_runs'.`) + cmd.Flags().Int64Var(&cancelAllRunsReq.JobId, "job-id", cancelAllRunsReq.JobId, `The canonical identifier of the job to cancel all runs of. Wire name: 'job_id'.`) cmd.Use = "cancel-all-runs" cmd.Short = `Cancel all runs of a job.` @@ -547,7 +547,7 @@ func newExportRun() *cobra.Command { var exportRunReq jobs.ExportRunRequest - cmd.Flags().Var(&exportRunReq.ViewsToExport, "views-to-export", `Which views to export (CODE, DASHBOARDS, or ALL). Supported values: [ALL, CODE, DASHBOARDS]`) + cmd.Flags().Var(&exportRunReq.ViewsToExport, "views-to-export", `Which views to export (CODE, DASHBOARDS, or ALL). Supported values: [ALL, CODE, DASHBOARDS]. Wire name: 'views_to_export'.`) cmd.Use = "export-run RUN_ID" cmd.Short = `Export and retrieve a job run.` @@ -620,7 +620,7 @@ func newGet() *cobra.Command { var getReq jobs.GetJobRequest - cmd.Flags().StringVar(&getReq.PageToken, "page-token", getReq.PageToken, `Use next_page_token returned from the previous GetJob response to request the next page of the job's array properties.`) + cmd.Flags().StringVar(&getReq.PageToken, "page-token", getReq.PageToken, `Use next_page_token returned from the previous GetJob response to request the next page of the job's array properties. Wire name: 'page_token'.`) cmd.Use = "get JOB_ID" cmd.Short = `Get a single job.` @@ -840,9 +840,9 @@ func newGetRun() *cobra.Command { var getRunReq jobs.GetRunRequest - cmd.Flags().BoolVar(&getRunReq.IncludeHistory, "include-history", getRunReq.IncludeHistory, `Whether to include the repair history in the response.`) - cmd.Flags().BoolVar(&getRunReq.IncludeResolvedValues, "include-resolved-values", getRunReq.IncludeResolvedValues, `Whether to include resolved parameter values in the response.`) - cmd.Flags().StringVar(&getRunReq.PageToken, "page-token", getRunReq.PageToken, `Use next_page_token returned from the previous GetRun response to request the next page of the run's array properties.`) + cmd.Flags().BoolVar(&getRunReq.IncludeHistory, "include-history", getRunReq.IncludeHistory, `Whether to include the repair history in the response. Wire name: 'include_history'.`) + cmd.Flags().BoolVar(&getRunReq.IncludeResolvedValues, "include-resolved-values", getRunReq.IncludeResolvedValues, `Whether to include resolved parameter values in the response. Wire name: 'include_resolved_values'.`) + cmd.Flags().StringVar(&getRunReq.PageToken, "page-token", getRunReq.PageToken, `Use next_page_token returned from the previous GetRun response to request the next page of the run's array properties. Wire name: 'page_token'.`) cmd.Use = "get-run RUN_ID" cmd.Short = `Get a single job run.` @@ -1005,11 +1005,11 @@ func newList() *cobra.Command { var listReq jobs.ListJobsRequest - cmd.Flags().BoolVar(&listReq.ExpandTasks, "expand-tasks", listReq.ExpandTasks, `Whether to include task and cluster details in the response.`) - cmd.Flags().IntVar(&listReq.Limit, "limit", listReq.Limit, `The number of jobs to return.`) - cmd.Flags().StringVar(&listReq.Name, "name", listReq.Name, `A filter on the list based on the exact (case insensitive) job name.`) - cmd.Flags().IntVar(&listReq.Offset, "offset", listReq.Offset, `The offset of the first job to return, relative to the most recently created job.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of jobs respectively.`) + cmd.Flags().BoolVar(&listReq.ExpandTasks, "expand-tasks", listReq.ExpandTasks, `Whether to include task and cluster details in the response. Wire name: 'expand_tasks'.`) + cmd.Flags().IntVar(&listReq.Limit, "limit", listReq.Limit, `The number of jobs to return. Wire name: 'limit'.`) + cmd.Flags().StringVar(&listReq.Name, "name", listReq.Name, `A filter on the list based on the exact (case insensitive) job name. Wire name: 'name'.`) + cmd.Flags().IntVar(&listReq.Offset, "offset", listReq.Offset, `The offset of the first job to return, relative to the most recently created job. Wire name: 'offset'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of jobs respectively. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List jobs.` @@ -1059,16 +1059,16 @@ func newListRuns() *cobra.Command { var listRunsReq jobs.ListRunsRequest - cmd.Flags().BoolVar(&listRunsReq.ActiveOnly, "active-only", listRunsReq.ActiveOnly, `If active_only is true, only active runs are included in the results; otherwise, lists both active and completed runs.`) - cmd.Flags().BoolVar(&listRunsReq.CompletedOnly, "completed-only", listRunsReq.CompletedOnly, `If completed_only is true, only completed runs are included in the results; otherwise, lists both active and completed runs.`) - cmd.Flags().BoolVar(&listRunsReq.ExpandTasks, "expand-tasks", listRunsReq.ExpandTasks, `Whether to include task and cluster details in the response.`) - cmd.Flags().Int64Var(&listRunsReq.JobId, "job-id", listRunsReq.JobId, `The job for which to list runs.`) - cmd.Flags().IntVar(&listRunsReq.Limit, "limit", listRunsReq.Limit, `The number of runs to return.`) - cmd.Flags().IntVar(&listRunsReq.Offset, "offset", listRunsReq.Offset, `The offset of the first run to return, relative to the most recent run.`) - cmd.Flags().StringVar(&listRunsReq.PageToken, "page-token", listRunsReq.PageToken, `Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of runs respectively.`) - cmd.Flags().Var(&listRunsReq.RunType, "run-type", `The type of runs to return. Supported values: [JOB_RUN, SUBMIT_RUN, WORKFLOW_RUN]`) - cmd.Flags().Int64Var(&listRunsReq.StartTimeFrom, "start-time-from", listRunsReq.StartTimeFrom, `Show runs that started _at or after_ this value.`) - cmd.Flags().Int64Var(&listRunsReq.StartTimeTo, "start-time-to", listRunsReq.StartTimeTo, `Show runs that started _at or before_ this value.`) + cmd.Flags().BoolVar(&listRunsReq.ActiveOnly, "active-only", listRunsReq.ActiveOnly, `If active_only is true, only active runs are included in the results; otherwise, lists both active and completed runs. Wire name: 'active_only'.`) + cmd.Flags().BoolVar(&listRunsReq.CompletedOnly, "completed-only", listRunsReq.CompletedOnly, `If completed_only is true, only completed runs are included in the results; otherwise, lists both active and completed runs. Wire name: 'completed_only'.`) + cmd.Flags().BoolVar(&listRunsReq.ExpandTasks, "expand-tasks", listRunsReq.ExpandTasks, `Whether to include task and cluster details in the response. Wire name: 'expand_tasks'.`) + cmd.Flags().Int64Var(&listRunsReq.JobId, "job-id", listRunsReq.JobId, `The job for which to list runs. Wire name: 'job_id'.`) + cmd.Flags().IntVar(&listRunsReq.Limit, "limit", listRunsReq.Limit, `The number of runs to return. Wire name: 'limit'.`) + cmd.Flags().IntVar(&listRunsReq.Offset, "offset", listRunsReq.Offset, `The offset of the first run to return, relative to the most recent run. Wire name: 'offset'.`) + cmd.Flags().StringVar(&listRunsReq.PageToken, "page-token", listRunsReq.PageToken, `Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of runs respectively. Wire name: 'page_token'.`) + cmd.Flags().Var(&listRunsReq.RunType, "run-type", `The type of runs to return. Supported values: [JOB_RUN, SUBMIT_RUN, WORKFLOW_RUN]. Wire name: 'run_type'.`) + cmd.Flags().Int64Var(&listRunsReq.StartTimeFrom, "start-time-from", listRunsReq.StartTimeFrom, `Show runs that started _at or after_ this value. Wire name: 'start_time_from'.`) + cmd.Flags().Int64Var(&listRunsReq.StartTimeTo, "start-time-to", listRunsReq.StartTimeTo, `Show runs that started _at or before_ this value. Wire name: 'start_time_to'.`) cmd.Use = "list-runs" cmd.Short = `List job runs.` @@ -1130,14 +1130,14 @@ func newRepairRun() *cobra.Command { // TODO: array: dbt_commands // TODO: array: jar_params // TODO: map via StringToStringVar: job_parameters - cmd.Flags().Int64Var(&repairRunReq.LatestRepairId, "latest-repair-id", repairRunReq.LatestRepairId, `The ID of the latest repair.`) + cmd.Flags().Int64Var(&repairRunReq.LatestRepairId, "latest-repair-id", repairRunReq.LatestRepairId, `The ID of the latest repair. Wire name: 'latest_repair_id'.`) // TODO: map via StringToStringVar: notebook_params - cmd.Flags().Var(&repairRunReq.PerformanceTarget, "performance-target", `The performance mode on a serverless job. Supported values: [PERFORMANCE_OPTIMIZED, STANDARD]`) + cmd.Flags().Var(&repairRunReq.PerformanceTarget, "performance-target", `The performance mode on a serverless job. Supported values: [PERFORMANCE_OPTIMIZED, STANDARD]. Wire name: 'performance_target'.`) // TODO: complex arg: pipeline_params // TODO: map via StringToStringVar: python_named_params // TODO: array: python_params - cmd.Flags().BoolVar(&repairRunReq.RerunAllFailedTasks, "rerun-all-failed-tasks", repairRunReq.RerunAllFailedTasks, `If true, repair all failed tasks.`) - cmd.Flags().BoolVar(&repairRunReq.RerunDependentTasks, "rerun-dependent-tasks", repairRunReq.RerunDependentTasks, `If true, repair all tasks that depend on the tasks in rerun_tasks, even if they were previously successful.`) + cmd.Flags().BoolVar(&repairRunReq.RerunAllFailedTasks, "rerun-all-failed-tasks", repairRunReq.RerunAllFailedTasks, `If true, repair all failed tasks. Wire name: 'rerun_all_failed_tasks'.`) + cmd.Flags().BoolVar(&repairRunReq.RerunDependentTasks, "rerun-dependent-tasks", repairRunReq.RerunDependentTasks, `If true, repair all tasks that depend on the tasks in rerun_tasks, even if they were previously successful. Wire name: 'rerun_dependent_tasks'.`) // TODO: array: rerun_tasks // TODO: array: spark_submit_params // TODO: map via StringToStringVar: sql_params @@ -1334,12 +1334,12 @@ func newRunNow() *cobra.Command { cmd.Flags().Var(&runNowJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: dbt_commands - cmd.Flags().StringVar(&runNowReq.IdempotencyToken, "idempotency-token", runNowReq.IdempotencyToken, `An optional token to guarantee the idempotency of job run requests.`) + cmd.Flags().StringVar(&runNowReq.IdempotencyToken, "idempotency-token", runNowReq.IdempotencyToken, `An optional token to guarantee the idempotency of job run requests. Wire name: 'idempotency_token'.`) // TODO: array: jar_params // TODO: map via StringToStringVar: job_parameters // TODO: map via StringToStringVar: notebook_params // TODO: array: only - cmd.Flags().Var(&runNowReq.PerformanceTarget, "performance-target", `The performance mode on a serverless job. Supported values: [PERFORMANCE_OPTIMIZED, STANDARD]`) + cmd.Flags().Var(&runNowReq.PerformanceTarget, "performance-target", `The performance mode on a serverless job. Supported values: [PERFORMANCE_OPTIMIZED, STANDARD]. Wire name: 'performance_target'.`) // TODO: complex arg: pipeline_params // TODO: map via StringToStringVar: python_named_params // TODO: array: python_params @@ -1559,19 +1559,19 @@ func newSubmit() *cobra.Command { cmd.Flags().Var(&submitJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: access_control_list - cmd.Flags().StringVar(&submitReq.BudgetPolicyId, "budget-policy-id", submitReq.BudgetPolicyId, `The user specified id of the budget policy to use for this one-time run.`) + cmd.Flags().StringVar(&submitReq.BudgetPolicyId, "budget-policy-id", submitReq.BudgetPolicyId, `The user specified id of the budget policy to use for this one-time run. Wire name: 'budget_policy_id'.`) // TODO: complex arg: email_notifications // TODO: array: environments // TODO: complex arg: git_source // TODO: complex arg: health - cmd.Flags().StringVar(&submitReq.IdempotencyToken, "idempotency-token", submitReq.IdempotencyToken, `An optional token that can be used to guarantee the idempotency of job run requests.`) + cmd.Flags().StringVar(&submitReq.IdempotencyToken, "idempotency-token", submitReq.IdempotencyToken, `An optional token that can be used to guarantee the idempotency of job run requests. Wire name: 'idempotency_token'.`) // TODO: complex arg: notification_settings // TODO: complex arg: queue // TODO: complex arg: run_as - cmd.Flags().StringVar(&submitReq.RunName, "run-name", submitReq.RunName, `An optional name for the run.`) + cmd.Flags().StringVar(&submitReq.RunName, "run-name", submitReq.RunName, `An optional name for the run. Wire name: 'run_name'.`) // TODO: array: tasks - cmd.Flags().IntVar(&submitReq.TimeoutSeconds, "timeout-seconds", submitReq.TimeoutSeconds, `An optional timeout applied to each run of this job.`) - cmd.Flags().StringVar(&submitReq.UsagePolicyId, "usage-policy-id", submitReq.UsagePolicyId, `The user specified id of the usage policy to use for this one-time run.`) + cmd.Flags().IntVar(&submitReq.TimeoutSeconds, "timeout-seconds", submitReq.TimeoutSeconds, `An optional timeout applied to each run of this job. Wire name: 'timeout_seconds'.`) + cmd.Flags().StringVar(&submitReq.UsagePolicyId, "usage-policy-id", submitReq.UsagePolicyId, `The user specified id of the usage policy to use for this one-time run. Wire name: 'usage_policy_id'.`) // TODO: complex arg: webhook_notifications cmd.Use = "submit" diff --git a/cmd/workspace/lakeview-embedded/lakeview-embedded.go b/cmd/workspace/lakeview-embedded/lakeview-embedded.go index 5700d23645..1b84cb964b 100755 --- a/cmd/workspace/lakeview-embedded/lakeview-embedded.go +++ b/cmd/workspace/lakeview-embedded/lakeview-embedded.go @@ -51,8 +51,8 @@ func newGetPublishedDashboardTokenInfo() *cobra.Command { var getPublishedDashboardTokenInfoReq dashboards.GetPublishedDashboardTokenInfoRequest - cmd.Flags().StringVar(&getPublishedDashboardTokenInfoReq.ExternalValue, "external-value", getPublishedDashboardTokenInfoReq.ExternalValue, `Provided external value to be included in the custom claim.`) - cmd.Flags().StringVar(&getPublishedDashboardTokenInfoReq.ExternalViewerId, "external-viewer-id", getPublishedDashboardTokenInfoReq.ExternalViewerId, `Provided external viewer id to be included in the custom claim.`) + cmd.Flags().StringVar(&getPublishedDashboardTokenInfoReq.ExternalValue, "external-value", getPublishedDashboardTokenInfoReq.ExternalValue, `Provided external value to be included in the custom claim. Wire name: 'external_value'.`) + cmd.Flags().StringVar(&getPublishedDashboardTokenInfoReq.ExternalViewerId, "external-viewer-id", getPublishedDashboardTokenInfoReq.ExternalViewerId, `Provided external viewer id to be included in the custom claim. Wire name: 'external_viewer_id'.`) cmd.Use = "get-published-dashboard-token-info DASHBOARD_ID" cmd.Short = `Read information of a published dashboard to mint an OAuth token.` diff --git a/cmd/workspace/lakeview/lakeview.go b/cmd/workspace/lakeview/lakeview.go index b3b0997855..d339307b6e 100755 --- a/cmd/workspace/lakeview/lakeview.go +++ b/cmd/workspace/lakeview/lakeview.go @@ -77,9 +77,9 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Dashboard.DisplayName, "display-name", createReq.Dashboard.DisplayName, `The display name of the dashboard.`) - cmd.Flags().StringVar(&createReq.Dashboard.SerializedDashboard, "serialized-dashboard", createReq.Dashboard.SerializedDashboard, `The contents of the dashboard in serialized string form.`) - cmd.Flags().StringVar(&createReq.Dashboard.WarehouseId, "warehouse-id", createReq.Dashboard.WarehouseId, `The warehouse ID used to run the dashboard.`) + cmd.Flags().StringVar(&createReq.Dashboard.DisplayName, "display-name", createReq.Dashboard.DisplayName, `The display name of the dashboard. Wire name: 'display_name'.`) + cmd.Flags().StringVar(&createReq.Dashboard.SerializedDashboard, "serialized-dashboard", createReq.Dashboard.SerializedDashboard, `The contents of the dashboard in serialized string form. Wire name: 'serialized_dashboard'.`) + cmd.Flags().StringVar(&createReq.Dashboard.WarehouseId, "warehouse-id", createReq.Dashboard.WarehouseId, `The warehouse ID used to run the dashboard. Wire name: 'warehouse_id'.`) cmd.Use = "create" cmd.Short = `Create dashboard.` @@ -149,9 +149,9 @@ func newCreateSchedule() *cobra.Command { cmd.Flags().Var(&createScheduleJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createScheduleReq.Schedule.DisplayName, "display-name", createScheduleReq.Schedule.DisplayName, `The display name for schedule.`) - cmd.Flags().Var(&createScheduleReq.Schedule.PauseStatus, "pause-status", `The status indicates whether this schedule is paused or not. Supported values: [PAUSED, UNPAUSED]`) - cmd.Flags().StringVar(&createScheduleReq.Schedule.WarehouseId, "warehouse-id", createScheduleReq.Schedule.WarehouseId, `The warehouse id to run the dashboard with for the schedule.`) + cmd.Flags().StringVar(&createScheduleReq.Schedule.DisplayName, "display-name", createScheduleReq.Schedule.DisplayName, `The display name for schedule. Wire name: 'display_name'.`) + cmd.Flags().Var(&createScheduleReq.Schedule.PauseStatus, "pause-status", `The status indicates whether this schedule is paused or not. Supported values: [PAUSED, UNPAUSED]. Wire name: 'pause_status'.`) + cmd.Flags().StringVar(&createScheduleReq.Schedule.WarehouseId, "warehouse-id", createScheduleReq.Schedule.WarehouseId, `The warehouse id to run the dashboard with for the schedule. Wire name: 'warehouse_id'.`) cmd.Use = "create-schedule DASHBOARD_ID CRON_SCHEDULE" cmd.Short = `Create dashboard schedule.` @@ -323,7 +323,7 @@ func newDeleteSchedule() *cobra.Command { var deleteScheduleReq dashboards.DeleteScheduleRequest - cmd.Flags().StringVar(&deleteScheduleReq.Etag, "etag", deleteScheduleReq.Etag, `The etag for the schedule.`) + cmd.Flags().StringVar(&deleteScheduleReq.Etag, "etag", deleteScheduleReq.Etag, `The etag for the schedule. Wire name: 'etag'.`) cmd.Use = "delete-schedule DASHBOARD_ID SCHEDULE_ID" cmd.Short = `Delete dashboard schedule.` @@ -381,7 +381,7 @@ func newDeleteSubscription() *cobra.Command { var deleteSubscriptionReq dashboards.DeleteSubscriptionRequest - cmd.Flags().StringVar(&deleteSubscriptionReq.Etag, "etag", deleteSubscriptionReq.Etag, `The etag for the subscription.`) + cmd.Flags().StringVar(&deleteSubscriptionReq.Etag, "etag", deleteSubscriptionReq.Etag, `The etag for the subscription. Wire name: 'etag'.`) cmd.Use = "delete-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID" cmd.Short = `Delete schedule subscription.` @@ -667,10 +667,10 @@ func newList() *cobra.Command { var listReq dashboards.ListDashboardsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `The number of dashboards to return per page.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A page token, received from a previous ListDashboards call.`) - cmd.Flags().BoolVar(&listReq.ShowTrashed, "show-trashed", listReq.ShowTrashed, `The flag to include dashboards located in the trash.`) - cmd.Flags().Var(&listReq.View, "view", `DASHBOARD_VIEW_BASIConly includes summary metadata from the dashboard. Supported values: [DASHBOARD_VIEW_BASIC]`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `The number of dashboards to return per page. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A page token, received from a previous ListDashboards call. Wire name: 'page_token'.`) + cmd.Flags().BoolVar(&listReq.ShowTrashed, "show-trashed", listReq.ShowTrashed, `The flag to include dashboards located in the trash. Wire name: 'show_trashed'.`) + cmd.Flags().Var(&listReq.View, "view", `DASHBOARD_VIEW_BASIConly includes summary metadata from the dashboard. Supported values: [DASHBOARD_VIEW_BASIC]. Wire name: 'view'.`) cmd.Use = "list" cmd.Short = `List dashboards.` @@ -718,8 +718,8 @@ func newListSchedules() *cobra.Command { var listSchedulesReq dashboards.ListSchedulesRequest - cmd.Flags().IntVar(&listSchedulesReq.PageSize, "page-size", listSchedulesReq.PageSize, `The number of schedules to return per page.`) - cmd.Flags().StringVar(&listSchedulesReq.PageToken, "page-token", listSchedulesReq.PageToken, `A page token, received from a previous ListSchedules call.`) + cmd.Flags().IntVar(&listSchedulesReq.PageSize, "page-size", listSchedulesReq.PageSize, `The number of schedules to return per page. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listSchedulesReq.PageToken, "page-token", listSchedulesReq.PageToken, `A page token, received from a previous ListSchedules call. Wire name: 'page_token'.`) cmd.Use = "list-schedules DASHBOARD_ID" cmd.Short = `List dashboard schedules.` @@ -772,8 +772,8 @@ func newListSubscriptions() *cobra.Command { var listSubscriptionsReq dashboards.ListSubscriptionsRequest - cmd.Flags().IntVar(&listSubscriptionsReq.PageSize, "page-size", listSubscriptionsReq.PageSize, `The number of subscriptions to return per page.`) - cmd.Flags().StringVar(&listSubscriptionsReq.PageToken, "page-token", listSubscriptionsReq.PageToken, `A page token, received from a previous ListSubscriptions call.`) + cmd.Flags().IntVar(&listSubscriptionsReq.PageSize, "page-size", listSubscriptionsReq.PageSize, `The number of subscriptions to return per page. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listSubscriptionsReq.PageToken, "page-token", listSubscriptionsReq.PageToken, `A page token, received from a previous ListSubscriptions call. Wire name: 'page_token'.`) cmd.Use = "list-subscriptions DASHBOARD_ID SCHEDULE_ID" cmd.Short = `List schedule subscriptions.` @@ -831,9 +831,9 @@ func newMigrate() *cobra.Command { cmd.Flags().Var(&migrateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&migrateReq.DisplayName, "display-name", migrateReq.DisplayName, `Display name for the new Lakeview dashboard.`) - cmd.Flags().StringVar(&migrateReq.ParentPath, "parent-path", migrateReq.ParentPath, `The workspace path of the folder to contain the migrated Lakeview dashboard.`) - cmd.Flags().BoolVar(&migrateReq.UpdateParameterSyntax, "update-parameter-syntax", migrateReq.UpdateParameterSyntax, `Flag to indicate if mustache parameter syntax ({{ param }}) should be auto-updated to named syntax (:param) when converting datasets in the dashboard.`) + cmd.Flags().StringVar(&migrateReq.DisplayName, "display-name", migrateReq.DisplayName, `Display name for the new Lakeview dashboard. Wire name: 'display_name'.`) + cmd.Flags().StringVar(&migrateReq.ParentPath, "parent-path", migrateReq.ParentPath, `The workspace path of the folder to contain the migrated Lakeview dashboard. Wire name: 'parent_path'.`) + cmd.Flags().BoolVar(&migrateReq.UpdateParameterSyntax, "update-parameter-syntax", migrateReq.UpdateParameterSyntax, `Flag to indicate if mustache parameter syntax ({{ param }}) should be auto-updated to named syntax (:param) when converting datasets in the dashboard. Wire name: 'update_parameter_syntax'.`) cmd.Use = "migrate SOURCE_DASHBOARD_ID" cmd.Short = `Migrate dashboard.` @@ -915,8 +915,8 @@ func newPublish() *cobra.Command { cmd.Flags().Var(&publishJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&publishReq.EmbedCredentials, "embed-credentials", publishReq.EmbedCredentials, `Flag to indicate if the publisher's credentials should be embedded in the published dashboard.`) - cmd.Flags().StringVar(&publishReq.WarehouseId, "warehouse-id", publishReq.WarehouseId, `The ID of the warehouse that can be used to override the warehouse which was set in the draft.`) + cmd.Flags().BoolVar(&publishReq.EmbedCredentials, "embed-credentials", publishReq.EmbedCredentials, `Flag to indicate if the publisher's credentials should be embedded in the published dashboard. Wire name: 'embed_credentials'.`) + cmd.Flags().StringVar(&publishReq.WarehouseId, "warehouse-id", publishReq.WarehouseId, `The ID of the warehouse that can be used to override the warehouse which was set in the draft. Wire name: 'warehouse_id'.`) cmd.Use = "publish DASHBOARD_ID" cmd.Short = `Publish dashboard.` @@ -1102,9 +1102,9 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Dashboard.DisplayName, "display-name", updateReq.Dashboard.DisplayName, `The display name of the dashboard.`) - cmd.Flags().StringVar(&updateReq.Dashboard.SerializedDashboard, "serialized-dashboard", updateReq.Dashboard.SerializedDashboard, `The contents of the dashboard in serialized string form.`) - cmd.Flags().StringVar(&updateReq.Dashboard.WarehouseId, "warehouse-id", updateReq.Dashboard.WarehouseId, `The warehouse ID used to run the dashboard.`) + cmd.Flags().StringVar(&updateReq.Dashboard.DisplayName, "display-name", updateReq.Dashboard.DisplayName, `The display name of the dashboard. Wire name: 'display_name'.`) + cmd.Flags().StringVar(&updateReq.Dashboard.SerializedDashboard, "serialized-dashboard", updateReq.Dashboard.SerializedDashboard, `The contents of the dashboard in serialized string form. Wire name: 'serialized_dashboard'.`) + cmd.Flags().StringVar(&updateReq.Dashboard.WarehouseId, "warehouse-id", updateReq.Dashboard.WarehouseId, `The warehouse ID used to run the dashboard. Wire name: 'warehouse_id'.`) cmd.Use = "update DASHBOARD_ID" cmd.Short = `Update dashboard.` @@ -1178,9 +1178,9 @@ func newUpdateSchedule() *cobra.Command { cmd.Flags().Var(&updateScheduleJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateScheduleReq.Schedule.DisplayName, "display-name", updateScheduleReq.Schedule.DisplayName, `The display name for schedule.`) - cmd.Flags().Var(&updateScheduleReq.Schedule.PauseStatus, "pause-status", `The status indicates whether this schedule is paused or not. Supported values: [PAUSED, UNPAUSED]`) - cmd.Flags().StringVar(&updateScheduleReq.Schedule.WarehouseId, "warehouse-id", updateScheduleReq.Schedule.WarehouseId, `The warehouse id to run the dashboard with for the schedule.`) + cmd.Flags().StringVar(&updateScheduleReq.Schedule.DisplayName, "display-name", updateScheduleReq.Schedule.DisplayName, `The display name for schedule. Wire name: 'display_name'.`) + cmd.Flags().Var(&updateScheduleReq.Schedule.PauseStatus, "pause-status", `The status indicates whether this schedule is paused or not. Supported values: [PAUSED, UNPAUSED]. Wire name: 'pause_status'.`) + cmd.Flags().StringVar(&updateScheduleReq.Schedule.WarehouseId, "warehouse-id", updateScheduleReq.Schedule.WarehouseId, `The warehouse id to run the dashboard with for the schedule. Wire name: 'warehouse_id'.`) cmd.Use = "update-schedule DASHBOARD_ID SCHEDULE_ID CRON_SCHEDULE" cmd.Short = `Update dashboard schedule.` diff --git a/cmd/workspace/llm-proxy-partner-powered-workspace/llm-proxy-partner-powered-workspace.go b/cmd/workspace/llm-proxy-partner-powered-workspace/llm-proxy-partner-powered-workspace.go index 7faa64c2f7..bfb1c2a0d6 100755 --- a/cmd/workspace/llm-proxy-partner-powered-workspace/llm-proxy-partner-powered-workspace.go +++ b/cmd/workspace/llm-proxy-partner-powered-workspace/llm-proxy-partner-powered-workspace.go @@ -56,7 +56,7 @@ func newDelete() *cobra.Command { var deleteReq settings.DeleteLlmProxyPartnerPoweredWorkspaceRequest - cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "delete" cmd.Short = `Delete the enable partner powered AI features workspace setting.` @@ -110,7 +110,7 @@ func newGet() *cobra.Command { var getReq settings.GetLlmProxyPartnerPoweredWorkspaceRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the enable partner powered AI features workspace setting.` diff --git a/cmd/workspace/materialized-features/materialized-features.go b/cmd/workspace/materialized-features/materialized-features.go index cec625c8e0..39665a2b46 100755 --- a/cmd/workspace/materialized-features/materialized-features.go +++ b/cmd/workspace/materialized-features/materialized-features.go @@ -67,7 +67,7 @@ func newCreateFeatureTag() *cobra.Command { cmd.Flags().Var(&createFeatureTagJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createFeatureTagReq.FeatureTag.Value, "value", createFeatureTagReq.FeatureTag.Value, ``) + cmd.Flags().StringVar(&createFeatureTagReq.FeatureTag.Value, "value", createFeatureTagReq.FeatureTag.Value, `Wire name: 'value'.`) cmd.Use = "create-feature-tag TABLE_NAME FEATURE_NAME KEY" cmd.Short = `Create a feature tag.` @@ -316,8 +316,8 @@ func newListFeatureTags() *cobra.Command { var listFeatureTagsReq ml.ListFeatureTagsRequest - cmd.Flags().IntVar(&listFeatureTagsReq.PageSize, "page-size", listFeatureTagsReq.PageSize, `The maximum number of results to return.`) - cmd.Flags().StringVar(&listFeatureTagsReq.PageToken, "page-token", listFeatureTagsReq.PageToken, `Pagination token to go to the next page based on a previous query.`) + cmd.Flags().IntVar(&listFeatureTagsReq.PageSize, "page-size", listFeatureTagsReq.PageSize, `The maximum number of results to return. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listFeatureTagsReq.PageToken, "page-token", listFeatureTagsReq.PageToken, `Pagination token to go to the next page based on a previous query. Wire name: 'page_token'.`) cmd.Use = "list-feature-tags TABLE_NAME FEATURE_NAME" cmd.Short = `List all feature tags.` @@ -374,8 +374,8 @@ func newUpdateFeatureTag() *cobra.Command { cmd.Flags().Var(&updateFeatureTagJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateFeatureTagReq.UpdateMask, "update-mask", updateFeatureTagReq.UpdateMask, `The list of fields to update.`) - cmd.Flags().StringVar(&updateFeatureTagReq.FeatureTag.Value, "value", updateFeatureTagReq.FeatureTag.Value, ``) + cmd.Flags().StringVar(&updateFeatureTagReq.UpdateMask, "update-mask", updateFeatureTagReq.UpdateMask, `The list of fields to update. Wire name: 'update_mask'.`) + cmd.Flags().StringVar(&updateFeatureTagReq.FeatureTag.Value, "value", updateFeatureTagReq.FeatureTag.Value, `Wire name: 'value'.`) cmd.Use = "update-feature-tag TABLE_NAME FEATURE_NAME KEY" cmd.Short = `Update a feature tag.` diff --git a/cmd/workspace/metastores/metastores.go b/cmd/workspace/metastores/metastores.go index a407975d6f..235788484e 100755 --- a/cmd/workspace/metastores/metastores.go +++ b/cmd/workspace/metastores/metastores.go @@ -172,8 +172,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Region, "region", createReq.Region, `Cloud region which the metastore serves (e.g., us-west-2, westus).`) - cmd.Flags().StringVar(&createReq.StorageRoot, "storage-root", createReq.StorageRoot, `The storage root URL for metastore.`) + cmd.Flags().StringVar(&createReq.Region, "region", createReq.Region, `Cloud region which the metastore serves (e.g., us-west-2, westus). Wire name: 'region'.`) + cmd.Flags().StringVar(&createReq.StorageRoot, "storage-root", createReq.StorageRoot, `The storage root URL for metastore. Wire name: 'storage_root'.`) cmd.Use = "create NAME" cmd.Short = `Create a metastore.` @@ -298,7 +298,7 @@ func newDelete() *cobra.Command { var deleteReq catalog.DeleteMetastoreRequest - cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the metastore is not empty.`) + cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the metastore is not empty. Wire name: 'force'.`) cmd.Use = "delete ID" cmd.Short = `Delete a metastore.` @@ -413,8 +413,8 @@ func newList() *cobra.Command { var listReq catalog.ListMetastoresRequest - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of metastores to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of metastores to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List metastores.` @@ -582,13 +582,13 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.DeltaSharingOrganizationName, "delta-sharing-organization-name", updateReq.DeltaSharingOrganizationName, `The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name.`) - cmd.Flags().Int64Var(&updateReq.DeltaSharingRecipientTokenLifetimeInSeconds, "delta-sharing-recipient-token-lifetime-in-seconds", updateReq.DeltaSharingRecipientTokenLifetimeInSeconds, `The lifetime of delta sharing recipient token in seconds.`) - cmd.Flags().Var(&updateReq.DeltaSharingScope, "delta-sharing-scope", `The scope of Delta Sharing enabled for the metastore. Supported values: [INTERNAL, INTERNAL_AND_EXTERNAL]`) - cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the metastore.`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `The owner of the metastore.`) - cmd.Flags().StringVar(&updateReq.PrivilegeModelVersion, "privilege-model-version", updateReq.PrivilegeModelVersion, `Privilege model version of the metastore, of the form major.minor (e.g., 1.0).`) - cmd.Flags().StringVar(&updateReq.StorageRootCredentialId, "storage-root-credential-id", updateReq.StorageRootCredentialId, `UUID of storage credential to access the metastore storage_root.`) + cmd.Flags().StringVar(&updateReq.DeltaSharingOrganizationName, "delta-sharing-organization-name", updateReq.DeltaSharingOrganizationName, `The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name. Wire name: 'delta_sharing_organization_name'.`) + cmd.Flags().Int64Var(&updateReq.DeltaSharingRecipientTokenLifetimeInSeconds, "delta-sharing-recipient-token-lifetime-in-seconds", updateReq.DeltaSharingRecipientTokenLifetimeInSeconds, `The lifetime of delta sharing recipient token in seconds. Wire name: 'delta_sharing_recipient_token_lifetime_in_seconds'.`) + cmd.Flags().Var(&updateReq.DeltaSharingScope, "delta-sharing-scope", `The scope of Delta Sharing enabled for the metastore. Supported values: [INTERNAL, INTERNAL_AND_EXTERNAL]. Wire name: 'delta_sharing_scope'.`) + cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the metastore. Wire name: 'new_name'.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `The owner of the metastore. Wire name: 'owner'.`) + cmd.Flags().StringVar(&updateReq.PrivilegeModelVersion, "privilege-model-version", updateReq.PrivilegeModelVersion, `Privilege model version of the metastore, of the form major.minor (e.g., 1.0). Wire name: 'privilege_model_version'.`) + cmd.Flags().StringVar(&updateReq.StorageRootCredentialId, "storage-root-credential-id", updateReq.StorageRootCredentialId, `UUID of storage credential to access the metastore storage_root. Wire name: 'storage_root_credential_id'.`) cmd.Use = "update ID" cmd.Short = `Update a metastore.` @@ -663,8 +663,8 @@ func newUpdateAssignment() *cobra.Command { cmd.Flags().Var(&updateAssignmentJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateAssignmentReq.DefaultCatalogName, "default-catalog-name", updateAssignmentReq.DefaultCatalogName, `The name of the default catalog in the metastore.`) - cmd.Flags().StringVar(&updateAssignmentReq.MetastoreId, "metastore-id", updateAssignmentReq.MetastoreId, `The unique ID of the metastore.`) + cmd.Flags().StringVar(&updateAssignmentReq.DefaultCatalogName, "default-catalog-name", updateAssignmentReq.DefaultCatalogName, `The name of the default catalog in the metastore. Wire name: 'default_catalog_name'.`) + cmd.Flags().StringVar(&updateAssignmentReq.MetastoreId, "metastore-id", updateAssignmentReq.MetastoreId, `The unique ID of the metastore. Wire name: 'metastore_id'.`) cmd.Use = "update-assignment WORKSPACE_ID" cmd.Short = `Update an assignment.` diff --git a/cmd/workspace/model-registry/model-registry.go b/cmd/workspace/model-registry/model-registry.go index 8340a80cc9..69fd33477b 100755 --- a/cmd/workspace/model-registry/model-registry.go +++ b/cmd/workspace/model-registry/model-registry.go @@ -99,7 +99,7 @@ func newApproveTransitionRequest() *cobra.Command { cmd.Flags().Var(&approveTransitionRequestJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&approveTransitionRequestReq.Comment, "comment", approveTransitionRequestReq.Comment, `User-provided comment on the action.`) + cmd.Flags().StringVar(&approveTransitionRequestReq.Comment, "comment", approveTransitionRequestReq.Comment, `User-provided comment on the action. Wire name: 'comment'.`) cmd.Use = "approve-transition-request NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS" cmd.Short = `Approve transition request.` @@ -296,7 +296,7 @@ func newCreateModel() *cobra.Command { cmd.Flags().Var(&createModelJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createModelReq.Description, "description", createModelReq.Description, `Optional description for registered model.`) + cmd.Flags().StringVar(&createModelReq.Description, "description", createModelReq.Description, `Optional description for registered model. Wire name: 'description'.`) // TODO: array: tags cmd.Use = "create-model NAME" @@ -381,9 +381,9 @@ func newCreateModelVersion() *cobra.Command { cmd.Flags().Var(&createModelVersionJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createModelVersionReq.Description, "description", createModelVersionReq.Description, `Optional description for model version.`) - cmd.Flags().StringVar(&createModelVersionReq.RunId, "run-id", createModelVersionReq.RunId, `MLflow run ID for correlation, if source was generated by an experiment run in MLflow tracking server.`) - cmd.Flags().StringVar(&createModelVersionReq.RunLink, "run-link", createModelVersionReq.RunLink, `MLflow run link - this is the exact link of the run that generated this model version, potentially hosted at another instance of MLflow.`) + cmd.Flags().StringVar(&createModelVersionReq.Description, "description", createModelVersionReq.Description, `Optional description for model version. Wire name: 'description'.`) + cmd.Flags().StringVar(&createModelVersionReq.RunId, "run-id", createModelVersionReq.RunId, `MLflow run ID for correlation, if source was generated by an experiment run in MLflow tracking server. Wire name: 'run_id'.`) + cmd.Flags().StringVar(&createModelVersionReq.RunLink, "run-link", createModelVersionReq.RunLink, `MLflow run link - this is the exact link of the run that generated this model version, potentially hosted at another instance of MLflow. Wire name: 'run_link'.`) // TODO: array: tags cmd.Use = "create-model-version NAME SOURCE" @@ -470,7 +470,7 @@ func newCreateTransitionRequest() *cobra.Command { cmd.Flags().Var(&createTransitionRequestJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createTransitionRequestReq.Comment, "comment", createTransitionRequestReq.Comment, `User-provided comment on the action.`) + cmd.Flags().StringVar(&createTransitionRequestReq.Comment, "comment", createTransitionRequestReq.Comment, `User-provided comment on the action. Wire name: 'comment'.`) cmd.Use = "create-transition-request NAME VERSION STAGE" cmd.Short = `Make a transition request.` @@ -568,11 +568,11 @@ func newCreateWebhook() *cobra.Command { cmd.Flags().Var(&createWebhookJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createWebhookReq.Description, "description", createWebhookReq.Description, `User-specified description for the webhook.`) + cmd.Flags().StringVar(&createWebhookReq.Description, "description", createWebhookReq.Description, `User-specified description for the webhook. Wire name: 'description'.`) // TODO: complex arg: http_url_spec // TODO: complex arg: job_spec - cmd.Flags().StringVar(&createWebhookReq.ModelName, "model-name", createWebhookReq.ModelName, `If model name is not specified, a registry-wide webhook is created that listens for the specified events across all versions of all registered models.`) - cmd.Flags().Var(&createWebhookReq.Status, "status", `Enable or disable triggering the webhook, or put the webhook into test mode. Supported values: [ACTIVE, DISABLED, TEST_MODE]`) + cmd.Flags().StringVar(&createWebhookReq.ModelName, "model-name", createWebhookReq.ModelName, `If model name is not specified, a registry-wide webhook is created that listens for the specified events across all versions of all registered models. Wire name: 'model_name'.`) + cmd.Flags().Var(&createWebhookReq.Status, "status", `Enable or disable triggering the webhook, or put the webhook into test mode. Supported values: [ACTIVE, DISABLED, TEST_MODE]. Wire name: 'status'.`) cmd.Use = "create-webhook" cmd.Short = `Create a webhook.` @@ -925,7 +925,7 @@ func newDeleteTransitionRequest() *cobra.Command { var deleteTransitionRequestReq ml.DeleteTransitionRequestRequest - cmd.Flags().StringVar(&deleteTransitionRequestReq.Comment, "comment", deleteTransitionRequestReq.Comment, `User-provided comment on the action.`) + cmd.Flags().StringVar(&deleteTransitionRequestReq.Comment, "comment", deleteTransitionRequestReq.Comment, `User-provided comment on the action. Wire name: 'comment'.`) cmd.Use = "delete-transition-request NAME VERSION STAGE CREATOR" cmd.Short = `Delete a transition request.` @@ -1421,8 +1421,8 @@ func newListModels() *cobra.Command { var listModelsReq ml.ListModelsRequest - cmd.Flags().Int64Var(&listModelsReq.MaxResults, "max-results", listModelsReq.MaxResults, `Maximum number of registered models desired.`) - cmd.Flags().StringVar(&listModelsReq.PageToken, "page-token", listModelsReq.PageToken, `Pagination token to go to the next page based on a previous query.`) + cmd.Flags().Int64Var(&listModelsReq.MaxResults, "max-results", listModelsReq.MaxResults, `Maximum number of registered models desired. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listModelsReq.PageToken, "page-token", listModelsReq.PageToken, `Pagination token to go to the next page based on a previous query. Wire name: 'page_token'.`) cmd.Use = "list-models" cmd.Short = `List models.` @@ -1529,9 +1529,9 @@ func newListWebhooks() *cobra.Command { var listWebhooksReq ml.ListWebhooksRequest // TODO: array: events - cmd.Flags().Int64Var(&listWebhooksReq.MaxResults, "max-results", listWebhooksReq.MaxResults, ``) - cmd.Flags().StringVar(&listWebhooksReq.ModelName, "model-name", listWebhooksReq.ModelName, `Registered model name If not specified, all webhooks associated with the specified events are listed, regardless of their associated model.`) - cmd.Flags().StringVar(&listWebhooksReq.PageToken, "page-token", listWebhooksReq.PageToken, `Token indicating the page of artifact results to fetch.`) + cmd.Flags().Int64Var(&listWebhooksReq.MaxResults, "max-results", listWebhooksReq.MaxResults, `Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listWebhooksReq.ModelName, "model-name", listWebhooksReq.ModelName, `Registered model name If not specified, all webhooks associated with the specified events are listed, regardless of their associated model. Wire name: 'model_name'.`) + cmd.Flags().StringVar(&listWebhooksReq.PageToken, "page-token", listWebhooksReq.PageToken, `Token indicating the page of artifact results to fetch. Wire name: 'page_token'.`) cmd.Use = "list-webhooks" cmd.Short = `List registry webhooks.` @@ -1584,7 +1584,7 @@ func newRejectTransitionRequest() *cobra.Command { cmd.Flags().Var(&rejectTransitionRequestJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&rejectTransitionRequestReq.Comment, "comment", rejectTransitionRequestReq.Comment, `User-provided comment on the action.`) + cmd.Flags().StringVar(&rejectTransitionRequestReq.Comment, "comment", rejectTransitionRequestReq.Comment, `User-provided comment on the action. Wire name: 'comment'.`) cmd.Use = "reject-transition-request NAME VERSION STAGE" cmd.Short = `Reject a transition request.` @@ -1682,7 +1682,7 @@ func newRenameModel() *cobra.Command { cmd.Flags().Var(&renameModelJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&renameModelReq.NewName, "new-name", renameModelReq.NewName, `If provided, updates the name for this registered_model.`) + cmd.Flags().StringVar(&renameModelReq.NewName, "new-name", renameModelReq.NewName, `If provided, updates the name for this registered_model. Wire name: 'new_name'.`) cmd.Use = "rename-model NAME" cmd.Short = `Rename a model.` @@ -1761,10 +1761,10 @@ func newSearchModelVersions() *cobra.Command { var searchModelVersionsReq ml.SearchModelVersionsRequest - cmd.Flags().StringVar(&searchModelVersionsReq.Filter, "filter", searchModelVersionsReq.Filter, `String filter condition, like "name='my-model-name'".`) - cmd.Flags().Int64Var(&searchModelVersionsReq.MaxResults, "max-results", searchModelVersionsReq.MaxResults, `Maximum number of models desired.`) + cmd.Flags().StringVar(&searchModelVersionsReq.Filter, "filter", searchModelVersionsReq.Filter, `String filter condition, like "name='my-model-name'". Wire name: 'filter'.`) + cmd.Flags().Int64Var(&searchModelVersionsReq.MaxResults, "max-results", searchModelVersionsReq.MaxResults, `Maximum number of models desired. Wire name: 'max_results'.`) // TODO: array: order_by - cmd.Flags().StringVar(&searchModelVersionsReq.PageToken, "page-token", searchModelVersionsReq.PageToken, `Pagination token to go to next page based on previous search query.`) + cmd.Flags().StringVar(&searchModelVersionsReq.PageToken, "page-token", searchModelVersionsReq.PageToken, `Pagination token to go to next page based on previous search query. Wire name: 'page_token'.`) cmd.Use = "search-model-versions" cmd.Short = `Search model versions.` @@ -1814,10 +1814,10 @@ func newSearchModels() *cobra.Command { var searchModelsReq ml.SearchModelsRequest - cmd.Flags().StringVar(&searchModelsReq.Filter, "filter", searchModelsReq.Filter, `String filter condition, like "name LIKE 'my-model-name'".`) - cmd.Flags().Int64Var(&searchModelsReq.MaxResults, "max-results", searchModelsReq.MaxResults, `Maximum number of models desired.`) + cmd.Flags().StringVar(&searchModelsReq.Filter, "filter", searchModelsReq.Filter, `String filter condition, like "name LIKE 'my-model-name'". Wire name: 'filter'.`) + cmd.Flags().Int64Var(&searchModelsReq.MaxResults, "max-results", searchModelsReq.MaxResults, `Maximum number of models desired. Wire name: 'max_results'.`) // TODO: array: order_by - cmd.Flags().StringVar(&searchModelsReq.PageToken, "page-token", searchModelsReq.PageToken, `Pagination token to go to the next page based on a previous search query.`) + cmd.Flags().StringVar(&searchModelsReq.PageToken, "page-token", searchModelsReq.PageToken, `Pagination token to go to the next page based on a previous search query. Wire name: 'page_token'.`) cmd.Use = "search-models" cmd.Short = `Search models.` @@ -2148,7 +2148,7 @@ func newTestRegistryWebhook() *cobra.Command { TRANSITION_REQUEST_TO_ARCHIVED_CREATED, TRANSITION_REQUEST_TO_PRODUCTION_CREATED, TRANSITION_REQUEST_TO_STAGING_CREATED, -]`) +]. Wire name: 'event'.`) cmd.Use = "test-registry-webhook ID" cmd.Short = `Test a webhook.` @@ -2230,7 +2230,7 @@ func newTransitionStage() *cobra.Command { cmd.Flags().Var(&transitionStageJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&transitionStageReq.Comment, "comment", transitionStageReq.Comment, `User-provided comment on the action.`) + cmd.Flags().StringVar(&transitionStageReq.Comment, "comment", transitionStageReq.Comment, `User-provided comment on the action. Wire name: 'comment'.`) cmd.Use = "transition-stage NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS" cmd.Short = `Transition a stage.` @@ -2425,7 +2425,7 @@ func newUpdateModel() *cobra.Command { cmd.Flags().Var(&updateModelJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateModelReq.Description, "description", updateModelReq.Description, `If provided, updates the description for this registered_model.`) + cmd.Flags().StringVar(&updateModelReq.Description, "description", updateModelReq.Description, `If provided, updates the description for this registered_model. Wire name: 'description'.`) cmd.Use = "update-model NAME" cmd.Short = `Update model.` @@ -2507,7 +2507,7 @@ func newUpdateModelVersion() *cobra.Command { cmd.Flags().Var(&updateModelVersionJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateModelVersionReq.Description, "description", updateModelVersionReq.Description, `If provided, updates the description for this registered_model.`) + cmd.Flags().StringVar(&updateModelVersionReq.Description, "description", updateModelVersionReq.Description, `If provided, updates the description for this registered_model. Wire name: 'description'.`) cmd.Use = "update-model-version NAME VERSION" cmd.Short = `Update model version.` @@ -2667,11 +2667,11 @@ func newUpdateWebhook() *cobra.Command { cmd.Flags().Var(&updateWebhookJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateWebhookReq.Description, "description", updateWebhookReq.Description, `User-specified description for the webhook.`) + cmd.Flags().StringVar(&updateWebhookReq.Description, "description", updateWebhookReq.Description, `User-specified description for the webhook. Wire name: 'description'.`) // TODO: array: events // TODO: complex arg: http_url_spec // TODO: complex arg: job_spec - cmd.Flags().Var(&updateWebhookReq.Status, "status", `Supported values: [ACTIVE, DISABLED, TEST_MODE]`) + cmd.Flags().Var(&updateWebhookReq.Status, "status", `Supported values: [ACTIVE, DISABLED, TEST_MODE]. Wire name: 'status'.`) cmd.Use = "update-webhook ID" cmd.Short = `Update a webhook.` diff --git a/cmd/workspace/model-versions/model-versions.go b/cmd/workspace/model-versions/model-versions.go index 5219bd5f09..77405396ca 100755 --- a/cmd/workspace/model-versions/model-versions.go +++ b/cmd/workspace/model-versions/model-versions.go @@ -131,8 +131,8 @@ func newGet() *cobra.Command { var getReq catalog.GetModelVersionRequest - cmd.Flags().BoolVar(&getReq.IncludeAliases, "include-aliases", getReq.IncludeAliases, `Whether to include aliases associated with the model version in the response.`) - cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include model versions in the response for which the principal can only access selective metadata for.`) + cmd.Flags().BoolVar(&getReq.IncludeAliases, "include-aliases", getReq.IncludeAliases, `Whether to include aliases associated with the model version in the response. Wire name: 'include_aliases'.`) + cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include model versions in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) cmd.Use = "get FULL_NAME VERSION" cmd.Short = `Get a Model Version.` @@ -200,7 +200,7 @@ func newGetByAlias() *cobra.Command { var getByAliasReq catalog.GetByAliasRequest - cmd.Flags().BoolVar(&getByAliasReq.IncludeAliases, "include-aliases", getByAliasReq.IncludeAliases, `Whether to include aliases associated with the model version in the response.`) + cmd.Flags().BoolVar(&getByAliasReq.IncludeAliases, "include-aliases", getByAliasReq.IncludeAliases, `Whether to include aliases associated with the model version in the response. Wire name: 'include_aliases'.`) cmd.Use = "get-by-alias FULL_NAME ALIAS" cmd.Short = `Get Model Version By Alias.` @@ -265,9 +265,9 @@ func newList() *cobra.Command { var listReq catalog.ListModelVersionsRequest - cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include model versions in the response for which the principal can only access selective metadata for.`) - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of model versions to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include model versions in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of model versions to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list FULL_NAME" cmd.Short = `List Model Versions.` @@ -344,22 +344,22 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: aliases - cmd.Flags().StringVar(&updateReq.CatalogName, "catalog-name", updateReq.CatalogName, `The name of the catalog containing the model version.`) - cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `The comment attached to the model version.`) - cmd.Flags().Int64Var(&updateReq.CreatedAt, "created-at", updateReq.CreatedAt, ``) - cmd.Flags().StringVar(&updateReq.CreatedBy, "created-by", updateReq.CreatedBy, `The identifier of the user who created the model version.`) - cmd.Flags().StringVar(&updateReq.Id, "id", updateReq.Id, `The unique identifier of the model version.`) - cmd.Flags().StringVar(&updateReq.MetastoreId, "metastore-id", updateReq.MetastoreId, `The unique identifier of the metastore containing the model version.`) - cmd.Flags().StringVar(&updateReq.ModelName, "model-name", updateReq.ModelName, `The name of the parent registered model of the model version, relative to parent schema.`) + cmd.Flags().StringVar(&updateReq.CatalogName, "catalog-name", updateReq.CatalogName, `The name of the catalog containing the model version. Wire name: 'catalog_name'.`) + cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `The comment attached to the model version. Wire name: 'comment'.`) + cmd.Flags().Int64Var(&updateReq.CreatedAt, "created-at", updateReq.CreatedAt, `Wire name: 'created_at'.`) + cmd.Flags().StringVar(&updateReq.CreatedBy, "created-by", updateReq.CreatedBy, `The identifier of the user who created the model version. Wire name: 'created_by'.`) + cmd.Flags().StringVar(&updateReq.Id, "id", updateReq.Id, `The unique identifier of the model version. Wire name: 'id'.`) + cmd.Flags().StringVar(&updateReq.MetastoreId, "metastore-id", updateReq.MetastoreId, `The unique identifier of the metastore containing the model version. Wire name: 'metastore_id'.`) + cmd.Flags().StringVar(&updateReq.ModelName, "model-name", updateReq.ModelName, `The name of the parent registered model of the model version, relative to parent schema. Wire name: 'model_name'.`) // TODO: complex arg: model_version_dependencies - cmd.Flags().StringVar(&updateReq.RunId, "run-id", updateReq.RunId, `MLflow run ID used when creating the model version, if source was generated by an experiment run stored in an MLflow tracking server.`) - cmd.Flags().IntVar(&updateReq.RunWorkspaceId, "run-workspace-id", updateReq.RunWorkspaceId, `ID of the Databricks workspace containing the MLflow run that generated this model version, if applicable.`) - cmd.Flags().StringVar(&updateReq.SchemaName, "schema-name", updateReq.SchemaName, `The name of the schema containing the model version, relative to parent catalog.`) - cmd.Flags().StringVar(&updateReq.Source, "source", updateReq.Source, `URI indicating the location of the source artifacts (files) for the model version.`) - cmd.Flags().Var(&updateReq.Status, "status", `Current status of the model version. Supported values: [FAILED_REGISTRATION, MODEL_VERSION_STATUS_UNKNOWN, PENDING_REGISTRATION, READY]`) - cmd.Flags().StringVar(&updateReq.StorageLocation, "storage-location", updateReq.StorageLocation, `The storage location on the cloud under which model version data files are stored.`) - cmd.Flags().Int64Var(&updateReq.UpdatedAt, "updated-at", updateReq.UpdatedAt, ``) - cmd.Flags().StringVar(&updateReq.UpdatedBy, "updated-by", updateReq.UpdatedBy, `The identifier of the user who updated the model version last time.`) + cmd.Flags().StringVar(&updateReq.RunId, "run-id", updateReq.RunId, `MLflow run ID used when creating the model version, if source was generated by an experiment run stored in an MLflow tracking server. Wire name: 'run_id'.`) + cmd.Flags().IntVar(&updateReq.RunWorkspaceId, "run-workspace-id", updateReq.RunWorkspaceId, `ID of the Databricks workspace containing the MLflow run that generated this model version, if applicable. Wire name: 'run_workspace_id'.`) + cmd.Flags().StringVar(&updateReq.SchemaName, "schema-name", updateReq.SchemaName, `The name of the schema containing the model version, relative to parent catalog. Wire name: 'schema_name'.`) + cmd.Flags().StringVar(&updateReq.Source, "source", updateReq.Source, `URI indicating the location of the source artifacts (files) for the model version. Wire name: 'source'.`) + cmd.Flags().Var(&updateReq.Status, "status", `Current status of the model version. Supported values: [FAILED_REGISTRATION, MODEL_VERSION_STATUS_UNKNOWN, PENDING_REGISTRATION, READY]. Wire name: 'status'.`) + cmd.Flags().StringVar(&updateReq.StorageLocation, "storage-location", updateReq.StorageLocation, `The storage location on the cloud under which model version data files are stored. Wire name: 'storage_location'.`) + cmd.Flags().Int64Var(&updateReq.UpdatedAt, "updated-at", updateReq.UpdatedAt, `Wire name: 'updated_at'.`) + cmd.Flags().StringVar(&updateReq.UpdatedBy, "updated-by", updateReq.UpdatedBy, `The identifier of the user who updated the model version last time. Wire name: 'updated_by'.`) cmd.Use = "update FULL_NAME VERSION" cmd.Short = `Update a Model Version.` diff --git a/cmd/workspace/notification-destinations/notification-destinations.go b/cmd/workspace/notification-destinations/notification-destinations.go index 785fc7559f..c7403725f0 100755 --- a/cmd/workspace/notification-destinations/notification-destinations.go +++ b/cmd/workspace/notification-destinations/notification-destinations.go @@ -64,7 +64,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: config - cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `The display name for the notification destination.`) + cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `The display name for the notification destination. Wire name: 'display_name'.`) cmd.Use = "create" cmd.Short = `Create a notification destination.` @@ -236,8 +236,8 @@ func newList() *cobra.Command { var listReq settings.ListNotificationDestinationsRequest - cmd.Flags().Int64Var(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().Int64Var(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List notification destinations.` @@ -291,7 +291,7 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: config - cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `The display name for the notification destination.`) + cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `The display name for the notification destination. Wire name: 'display_name'.`) cmd.Use = "update ID" cmd.Short = `Update a notification destination.` diff --git a/cmd/workspace/online-tables/online-tables.go b/cmd/workspace/online-tables/online-tables.go index 3fd6a5d8b5..39d2df929d 100755 --- a/cmd/workspace/online-tables/online-tables.go +++ b/cmd/workspace/online-tables/online-tables.go @@ -68,7 +68,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Table.Name, "name", createReq.Table.Name, `Full three-part (catalog, schema, table) name of the table.`) + cmd.Flags().StringVar(&createReq.Table.Name, "name", createReq.Table.Name, `Full three-part (catalog, schema, table) name of the table. Wire name: 'name'.`) // TODO: complex arg: spec // TODO: complex arg: status diff --git a/cmd/workspace/permission-migration/permission-migration.go b/cmd/workspace/permission-migration/permission-migration.go index 7f22f0883a..386941f079 100755 --- a/cmd/workspace/permission-migration/permission-migration.go +++ b/cmd/workspace/permission-migration/permission-migration.go @@ -61,7 +61,7 @@ func newMigratePermissions() *cobra.Command { cmd.Flags().Var(&migratePermissionsJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().IntVar(&migratePermissionsReq.Size, "size", migratePermissionsReq.Size, `The maximum number of permissions that will be migrated.`) + cmd.Flags().IntVar(&migratePermissionsReq.Size, "size", migratePermissionsReq.Size, `The maximum number of permissions that will be migrated. Wire name: 'size'.`) cmd.Use = "migrate-permissions WORKSPACE_ID FROM_WORKSPACE_GROUP_NAME TO_ACCOUNT_GROUP_NAME" cmd.Short = `Migrate Permissions.` diff --git a/cmd/workspace/pipelines/pipelines.go b/cmd/workspace/pipelines/pipelines.go index d58dd5f605..2dc49aa392 100755 --- a/cmd/workspace/pipelines/pipelines.go +++ b/cmd/workspace/pipelines/pipelines.go @@ -470,10 +470,10 @@ func newListPipelineEvents() *cobra.Command { var listPipelineEventsReq pipelines.ListPipelineEventsRequest - cmd.Flags().StringVar(&listPipelineEventsReq.Filter, "filter", listPipelineEventsReq.Filter, `Criteria to select a subset of results, expressed using a SQL-like syntax.`) - cmd.Flags().IntVar(&listPipelineEventsReq.MaxResults, "max-results", listPipelineEventsReq.MaxResults, `Max number of entries to return in a single page.`) + cmd.Flags().StringVar(&listPipelineEventsReq.Filter, "filter", listPipelineEventsReq.Filter, `Criteria to select a subset of results, expressed using a SQL-like syntax. Wire name: 'filter'.`) + cmd.Flags().IntVar(&listPipelineEventsReq.MaxResults, "max-results", listPipelineEventsReq.MaxResults, `Max number of entries to return in a single page. Wire name: 'max_results'.`) // TODO: array: order_by - cmd.Flags().StringVar(&listPipelineEventsReq.PageToken, "page-token", listPipelineEventsReq.PageToken, `Page token returned by previous call.`) + cmd.Flags().StringVar(&listPipelineEventsReq.PageToken, "page-token", listPipelineEventsReq.PageToken, `Page token returned by previous call. Wire name: 'page_token'.`) cmd.Use = "list-pipeline-events PIPELINE_ID" cmd.Short = `List pipeline events.` @@ -540,10 +540,10 @@ func newListPipelines() *cobra.Command { var listPipelinesReq pipelines.ListPipelinesRequest - cmd.Flags().StringVar(&listPipelinesReq.Filter, "filter", listPipelinesReq.Filter, `Select a subset of results based on the specified criteria.`) - cmd.Flags().IntVar(&listPipelinesReq.MaxResults, "max-results", listPipelinesReq.MaxResults, `The maximum number of entries to return in a single page.`) + cmd.Flags().StringVar(&listPipelinesReq.Filter, "filter", listPipelinesReq.Filter, `Select a subset of results based on the specified criteria. Wire name: 'filter'.`) + cmd.Flags().IntVar(&listPipelinesReq.MaxResults, "max-results", listPipelinesReq.MaxResults, `The maximum number of entries to return in a single page. Wire name: 'max_results'.`) // TODO: array: order_by - cmd.Flags().StringVar(&listPipelinesReq.PageToken, "page-token", listPipelinesReq.PageToken, `Page token returned by previous call.`) + cmd.Flags().StringVar(&listPipelinesReq.PageToken, "page-token", listPipelinesReq.PageToken, `Page token returned by previous call. Wire name: 'page_token'.`) cmd.Use = "list-pipelines" cmd.Short = `List pipelines.` @@ -593,9 +593,9 @@ func newListUpdates() *cobra.Command { var listUpdatesReq pipelines.ListUpdatesRequest - cmd.Flags().IntVar(&listUpdatesReq.MaxResults, "max-results", listUpdatesReq.MaxResults, `Max number of entries to return in a single page.`) - cmd.Flags().StringVar(&listUpdatesReq.PageToken, "page-token", listUpdatesReq.PageToken, `Page token returned by previous call.`) - cmd.Flags().StringVar(&listUpdatesReq.UntilUpdateId, "until-update-id", listUpdatesReq.UntilUpdateId, `If present, returns updates until and including this update_id.`) + cmd.Flags().IntVar(&listUpdatesReq.MaxResults, "max-results", listUpdatesReq.MaxResults, `Max number of entries to return in a single page. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listUpdatesReq.PageToken, "page-token", listUpdatesReq.PageToken, `Page token returned by previous call. Wire name: 'page_token'.`) + cmd.Flags().StringVar(&listUpdatesReq.UntilUpdateId, "until-update-id", listUpdatesReq.UntilUpdateId, `If present, returns updates until and including this update_id. Wire name: 'until_update_id'.`) cmd.Use = "list-updates PIPELINE_ID" cmd.Short = `List pipeline updates.` @@ -763,11 +763,11 @@ func newStartUpdate() *cobra.Command { SCHEMA_CHANGE, SERVICE_UPGRADE, USER_ACTION, -]`) - cmd.Flags().BoolVar(&startUpdateReq.FullRefresh, "full-refresh", startUpdateReq.FullRefresh, `If true, this update will reset all tables before running.`) +]. Wire name: 'cause'.`) + cmd.Flags().BoolVar(&startUpdateReq.FullRefresh, "full-refresh", startUpdateReq.FullRefresh, `If true, this update will reset all tables before running. Wire name: 'full_refresh'.`) // TODO: array: full_refresh_selection // TODO: array: refresh_selection - cmd.Flags().BoolVar(&startUpdateReq.ValidateOnly, "validate-only", startUpdateReq.ValidateOnly, `If true, this update only validates the correctness of pipeline source code but does not materialize or publish any datasets.`) + cmd.Flags().BoolVar(&startUpdateReq.ValidateOnly, "validate-only", startUpdateReq.ValidateOnly, `If true, this update only validates the correctness of pipeline source code but does not materialize or publish any datasets. Wire name: 'validate_only'.`) cmd.Use = "start-update PIPELINE_ID" cmd.Short = `Start a pipeline.` @@ -934,37 +934,37 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&updateReq.AllowDuplicateNames, "allow-duplicate-names", updateReq.AllowDuplicateNames, `If false, deployment will fail if name has changed and conflicts the name of another pipeline.`) - cmd.Flags().StringVar(&updateReq.BudgetPolicyId, "budget-policy-id", updateReq.BudgetPolicyId, `Budget policy of this pipeline.`) - cmd.Flags().StringVar(&updateReq.Catalog, "catalog", updateReq.Catalog, `A catalog in Unity Catalog to publish data from this pipeline to.`) - cmd.Flags().StringVar(&updateReq.Channel, "channel", updateReq.Channel, `DLT Release Channel that specifies which version to use.`) + cmd.Flags().BoolVar(&updateReq.AllowDuplicateNames, "allow-duplicate-names", updateReq.AllowDuplicateNames, `If false, deployment will fail if name has changed and conflicts the name of another pipeline. Wire name: 'allow_duplicate_names'.`) + cmd.Flags().StringVar(&updateReq.BudgetPolicyId, "budget-policy-id", updateReq.BudgetPolicyId, `Budget policy of this pipeline. Wire name: 'budget_policy_id'.`) + cmd.Flags().StringVar(&updateReq.Catalog, "catalog", updateReq.Catalog, `A catalog in Unity Catalog to publish data from this pipeline to. Wire name: 'catalog'.`) + cmd.Flags().StringVar(&updateReq.Channel, "channel", updateReq.Channel, `DLT Release Channel that specifies which version to use. Wire name: 'channel'.`) // TODO: array: clusters // TODO: map via StringToStringVar: configuration - cmd.Flags().BoolVar(&updateReq.Continuous, "continuous", updateReq.Continuous, `Whether the pipeline is continuous or triggered.`) + cmd.Flags().BoolVar(&updateReq.Continuous, "continuous", updateReq.Continuous, `Whether the pipeline is continuous or triggered. Wire name: 'continuous'.`) // TODO: complex arg: deployment - cmd.Flags().BoolVar(&updateReq.Development, "development", updateReq.Development, `Whether the pipeline is in Development mode.`) - cmd.Flags().StringVar(&updateReq.Edition, "edition", updateReq.Edition, `Pipeline product edition.`) + cmd.Flags().BoolVar(&updateReq.Development, "development", updateReq.Development, `Whether the pipeline is in Development mode. Wire name: 'development'.`) + cmd.Flags().StringVar(&updateReq.Edition, "edition", updateReq.Edition, `Pipeline product edition. Wire name: 'edition'.`) // TODO: complex arg: environment // TODO: complex arg: event_log - cmd.Flags().Int64Var(&updateReq.ExpectedLastModified, "expected-last-modified", updateReq.ExpectedLastModified, `If present, the last-modified time of the pipeline settings before the edit.`) + cmd.Flags().Int64Var(&updateReq.ExpectedLastModified, "expected-last-modified", updateReq.ExpectedLastModified, `If present, the last-modified time of the pipeline settings before the edit. Wire name: 'expected_last_modified'.`) // TODO: complex arg: filters // TODO: complex arg: gateway_definition - cmd.Flags().StringVar(&updateReq.Id, "id", updateReq.Id, `Unique identifier for this pipeline.`) + cmd.Flags().StringVar(&updateReq.Id, "id", updateReq.Id, `Unique identifier for this pipeline. Wire name: 'id'.`) // TODO: complex arg: ingestion_definition // TODO: array: libraries - cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `Friendly identifier for this pipeline.`) + cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `Friendly identifier for this pipeline. Wire name: 'name'.`) // TODO: array: notifications - cmd.Flags().BoolVar(&updateReq.Photon, "photon", updateReq.Photon, `Whether Photon is enabled for this pipeline.`) + cmd.Flags().BoolVar(&updateReq.Photon, "photon", updateReq.Photon, `Whether Photon is enabled for this pipeline. Wire name: 'photon'.`) // TODO: complex arg: restart_window - cmd.Flags().StringVar(&updateReq.RootPath, "root-path", updateReq.RootPath, `Root path for this pipeline.`) + cmd.Flags().StringVar(&updateReq.RootPath, "root-path", updateReq.RootPath, `Root path for this pipeline. Wire name: 'root_path'.`) // TODO: complex arg: run_as - cmd.Flags().StringVar(&updateReq.Schema, "schema", updateReq.Schema, `The default schema (database) where tables are read from or published to.`) - cmd.Flags().BoolVar(&updateReq.Serverless, "serverless", updateReq.Serverless, `Whether serverless compute is enabled for this pipeline.`) - cmd.Flags().StringVar(&updateReq.Storage, "storage", updateReq.Storage, `DBFS root directory for storing checkpoints and tables.`) + cmd.Flags().StringVar(&updateReq.Schema, "schema", updateReq.Schema, `The default schema (database) where tables are read from or published to. Wire name: 'schema'.`) + cmd.Flags().BoolVar(&updateReq.Serverless, "serverless", updateReq.Serverless, `Whether serverless compute is enabled for this pipeline. Wire name: 'serverless'.`) + cmd.Flags().StringVar(&updateReq.Storage, "storage", updateReq.Storage, `DBFS root directory for storing checkpoints and tables. Wire name: 'storage'.`) // TODO: map via StringToStringVar: tags - cmd.Flags().StringVar(&updateReq.Target, "target", updateReq.Target, `Target schema (database) to add tables in this pipeline to.`) + cmd.Flags().StringVar(&updateReq.Target, "target", updateReq.Target, `Target schema (database) to add tables in this pipeline to. Wire name: 'target'.`) // TODO: complex arg: trigger - cmd.Flags().StringVar(&updateReq.UsagePolicyId, "usage-policy-id", updateReq.UsagePolicyId, `Usage policy of this pipeline.`) + cmd.Flags().StringVar(&updateReq.UsagePolicyId, "usage-policy-id", updateReq.UsagePolicyId, `Usage policy of this pipeline. Wire name: 'usage_policy_id'.`) cmd.Use = "update PIPELINE_ID" cmd.Short = `Edit a pipeline.` diff --git a/cmd/workspace/policies/policies.go b/cmd/workspace/policies/policies.go index 15a45238f9..45b99105d9 100755 --- a/cmd/workspace/policies/policies.go +++ b/cmd/workspace/policies/policies.go @@ -70,11 +70,11 @@ func newCreatePolicy() *cobra.Command { cmd.Flags().Var(&createPolicyJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: column_mask - cmd.Flags().StringVar(&createPolicyReq.PolicyInfo.Comment, "comment", createPolicyReq.PolicyInfo.Comment, `Optional description of the policy.`) + cmd.Flags().StringVar(&createPolicyReq.PolicyInfo.Comment, "comment", createPolicyReq.PolicyInfo.Comment, `Optional description of the policy. Wire name: 'comment'.`) // TODO: array: except_principals // TODO: array: match_columns - cmd.Flags().StringVar(&createPolicyReq.PolicyInfo.Name, "name", createPolicyReq.PolicyInfo.Name, `Name of the policy.`) - cmd.Flags().StringVar(&createPolicyReq.PolicyInfo.OnSecurableFullname, "on-securable-fullname", createPolicyReq.PolicyInfo.OnSecurableFullname, `Full name of the securable on which the policy is defined.`) + cmd.Flags().StringVar(&createPolicyReq.PolicyInfo.Name, "name", createPolicyReq.PolicyInfo.Name, `Name of the policy. Wire name: 'name'.`) + cmd.Flags().StringVar(&createPolicyReq.PolicyInfo.OnSecurableFullname, "on-securable-fullname", createPolicyReq.PolicyInfo.OnSecurableFullname, `Full name of the securable on which the policy is defined. Wire name: 'on_securable_fullname'.`) cmd.Flags().Var(&createPolicyReq.PolicyInfo.OnSecurableType, "on-securable-type", `Type of the securable on which the policy is defined. Supported values: [ CATALOG, CLEAN_ROOM, @@ -93,9 +93,9 @@ func newCreatePolicy() *cobra.Command { STORAGE_CREDENTIAL, TABLE, VOLUME, -]`) +]. Wire name: 'on_securable_type'.`) // TODO: complex arg: row_filter - cmd.Flags().StringVar(&createPolicyReq.PolicyInfo.WhenCondition, "when-condition", createPolicyReq.PolicyInfo.WhenCondition, `Optional condition when the policy should take effect.`) + cmd.Flags().StringVar(&createPolicyReq.PolicyInfo.WhenCondition, "when-condition", createPolicyReq.PolicyInfo.WhenCondition, `Optional condition when the policy should take effect. Wire name: 'when_condition'.`) cmd.Use = "create-policy TO_PRINCIPALS FOR_SECURABLE_TYPE POLICY_TYPE" cmd.Short = `Create an ABAC policy.` @@ -338,9 +338,9 @@ func newListPolicies() *cobra.Command { var listPoliciesReq catalog.ListPoliciesRequest - cmd.Flags().BoolVar(&listPoliciesReq.IncludeInherited, "include-inherited", listPoliciesReq.IncludeInherited, `Optional.`) - cmd.Flags().IntVar(&listPoliciesReq.MaxResults, "max-results", listPoliciesReq.MaxResults, `Optional.`) - cmd.Flags().StringVar(&listPoliciesReq.PageToken, "page-token", listPoliciesReq.PageToken, `Optional.`) + cmd.Flags().BoolVar(&listPoliciesReq.IncludeInherited, "include-inherited", listPoliciesReq.IncludeInherited, `Optional. Wire name: 'include_inherited'.`) + cmd.Flags().IntVar(&listPoliciesReq.MaxResults, "max-results", listPoliciesReq.MaxResults, `Optional. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listPoliciesReq.PageToken, "page-token", listPoliciesReq.PageToken, `Optional. Wire name: 'page_token'.`) cmd.Use = "list-policies ON_SECURABLE_TYPE ON_SECURABLE_FULLNAME" cmd.Short = `List ABAC policies.` @@ -407,13 +407,13 @@ func newUpdatePolicy() *cobra.Command { cmd.Flags().Var(&updatePolicyJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updatePolicyReq.UpdateMask, "update-mask", updatePolicyReq.UpdateMask, `Optional.`) + cmd.Flags().StringVar(&updatePolicyReq.UpdateMask, "update-mask", updatePolicyReq.UpdateMask, `Optional. Wire name: 'update_mask'.`) // TODO: complex arg: column_mask - cmd.Flags().StringVar(&updatePolicyReq.PolicyInfo.Comment, "comment", updatePolicyReq.PolicyInfo.Comment, `Optional description of the policy.`) + cmd.Flags().StringVar(&updatePolicyReq.PolicyInfo.Comment, "comment", updatePolicyReq.PolicyInfo.Comment, `Optional description of the policy. Wire name: 'comment'.`) // TODO: array: except_principals // TODO: array: match_columns - cmd.Flags().StringVar(&updatePolicyReq.PolicyInfo.Name, "name", updatePolicyReq.PolicyInfo.Name, `Name of the policy.`) - cmd.Flags().StringVar(&updatePolicyReq.PolicyInfo.OnSecurableFullname, "on-securable-fullname", updatePolicyReq.PolicyInfo.OnSecurableFullname, `Full name of the securable on which the policy is defined.`) + cmd.Flags().StringVar(&updatePolicyReq.PolicyInfo.Name, "name", updatePolicyReq.PolicyInfo.Name, `Name of the policy. Wire name: 'name'.`) + cmd.Flags().StringVar(&updatePolicyReq.PolicyInfo.OnSecurableFullname, "on-securable-fullname", updatePolicyReq.PolicyInfo.OnSecurableFullname, `Full name of the securable on which the policy is defined. Wire name: 'on_securable_fullname'.`) cmd.Flags().Var(&updatePolicyReq.PolicyInfo.OnSecurableType, "on-securable-type", `Type of the securable on which the policy is defined. Supported values: [ CATALOG, CLEAN_ROOM, @@ -432,9 +432,9 @@ func newUpdatePolicy() *cobra.Command { STORAGE_CREDENTIAL, TABLE, VOLUME, -]`) +]. Wire name: 'on_securable_type'.`) // TODO: complex arg: row_filter - cmd.Flags().StringVar(&updatePolicyReq.PolicyInfo.WhenCondition, "when-condition", updatePolicyReq.PolicyInfo.WhenCondition, `Optional condition when the policy should take effect.`) + cmd.Flags().StringVar(&updatePolicyReq.PolicyInfo.WhenCondition, "when-condition", updatePolicyReq.PolicyInfo.WhenCondition, `Optional condition when the policy should take effect. Wire name: 'when_condition'.`) cmd.Use = "update-policy ON_SECURABLE_TYPE ON_SECURABLE_FULLNAME NAME TO_PRINCIPALS FOR_SECURABLE_TYPE POLICY_TYPE" cmd.Short = `Update an ABAC policy.` diff --git a/cmd/workspace/policy-compliance-for-clusters/policy-compliance-for-clusters.go b/cmd/workspace/policy-compliance-for-clusters/policy-compliance-for-clusters.go index 922a904288..0c5be0578f 100755 --- a/cmd/workspace/policy-compliance-for-clusters/policy-compliance-for-clusters.go +++ b/cmd/workspace/policy-compliance-for-clusters/policy-compliance-for-clusters.go @@ -68,7 +68,7 @@ func newEnforceCompliance() *cobra.Command { cmd.Flags().Var(&enforceComplianceJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&enforceComplianceReq.ValidateOnly, "validate-only", enforceComplianceReq.ValidateOnly, `If set, previews the changes that would be made to a cluster to enforce compliance but does not update the cluster.`) + cmd.Flags().BoolVar(&enforceComplianceReq.ValidateOnly, "validate-only", enforceComplianceReq.ValidateOnly, `If set, previews the changes that would be made to a cluster to enforce compliance but does not update the cluster. Wire name: 'validate_only'.`) cmd.Use = "enforce-compliance CLUSTER_ID" cmd.Short = `Enforce cluster policy compliance.` @@ -216,8 +216,8 @@ func newListCompliance() *cobra.Command { var listComplianceReq compute.ListClusterCompliancesRequest - cmd.Flags().IntVar(&listComplianceReq.PageSize, "page-size", listComplianceReq.PageSize, `Use this field to specify the maximum number of results to be returned by the server.`) - cmd.Flags().StringVar(&listComplianceReq.PageToken, "page-token", listComplianceReq.PageToken, `A page token that can be used to navigate to the next page or previous page as returned by next_page_token or prev_page_token.`) + cmd.Flags().IntVar(&listComplianceReq.PageSize, "page-size", listComplianceReq.PageSize, `Use this field to specify the maximum number of results to be returned by the server. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listComplianceReq.PageToken, "page-token", listComplianceReq.PageToken, `A page token that can be used to navigate to the next page or previous page as returned by next_page_token or prev_page_token. Wire name: 'page_token'.`) cmd.Use = "list-compliance POLICY_ID" cmd.Short = `List cluster policy compliance.` diff --git a/cmd/workspace/policy-compliance-for-jobs/policy-compliance-for-jobs.go b/cmd/workspace/policy-compliance-for-jobs/policy-compliance-for-jobs.go index 80ba0f7b85..a74e132134 100755 --- a/cmd/workspace/policy-compliance-for-jobs/policy-compliance-for-jobs.go +++ b/cmd/workspace/policy-compliance-for-jobs/policy-compliance-for-jobs.go @@ -71,7 +71,7 @@ func newEnforceCompliance() *cobra.Command { cmd.Flags().Var(&enforceComplianceJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&enforceComplianceReq.ValidateOnly, "validate-only", enforceComplianceReq.ValidateOnly, `If set, previews changes made to the job to comply with its policy, but does not update the job.`) + cmd.Flags().BoolVar(&enforceComplianceReq.ValidateOnly, "validate-only", enforceComplianceReq.ValidateOnly, `If set, previews changes made to the job to comply with its policy, but does not update the job. Wire name: 'validate_only'.`) cmd.Use = "enforce-compliance JOB_ID" cmd.Short = `Enforce job policy compliance.` @@ -218,8 +218,8 @@ func newListCompliance() *cobra.Command { var listComplianceReq jobs.ListJobComplianceRequest - cmd.Flags().IntVar(&listComplianceReq.PageSize, "page-size", listComplianceReq.PageSize, `Use this field to specify the maximum number of results to be returned by the server.`) - cmd.Flags().StringVar(&listComplianceReq.PageToken, "page-token", listComplianceReq.PageToken, `A page token that can be used to navigate to the next page or previous page as returned by next_page_token or prev_page_token.`) + cmd.Flags().IntVar(&listComplianceReq.PageSize, "page-size", listComplianceReq.PageSize, `Use this field to specify the maximum number of results to be returned by the server. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listComplianceReq.PageToken, "page-token", listComplianceReq.PageToken, `A page token that can be used to navigate to the next page or previous page as returned by next_page_token or prev_page_token. Wire name: 'page_token'.`) cmd.Use = "list-compliance POLICY_ID" cmd.Short = `List job policy compliance.` diff --git a/cmd/workspace/policy-families/policy-families.go b/cmd/workspace/policy-families/policy-families.go index 7af92490f6..f91d15f658 100755 --- a/cmd/workspace/policy-families/policy-families.go +++ b/cmd/workspace/policy-families/policy-families.go @@ -60,7 +60,7 @@ func newGet() *cobra.Command { var getReq compute.GetPolicyFamilyRequest - cmd.Flags().Int64Var(&getReq.Version, "version", getReq.Version, `The version number for the family to fetch.`) + cmd.Flags().Int64Var(&getReq.Version, "version", getReq.Version, `The version number for the family to fetch. Wire name: 'version'.`) cmd.Use = "get POLICY_FAMILY_ID" cmd.Short = `Get policy family information.` @@ -119,8 +119,8 @@ func newList() *cobra.Command { var listReq compute.ListPolicyFamiliesRequest - cmd.Flags().Int64Var(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of policy families to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A token that can be used to get the next page of results.`) + cmd.Flags().Int64Var(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of policy families to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A token that can be used to get the next page of results. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List policy families.` diff --git a/cmd/workspace/provider-exchange-filters/provider-exchange-filters.go b/cmd/workspace/provider-exchange-filters/provider-exchange-filters.go index 7b808c4ee8..ae0482ac22 100755 --- a/cmd/workspace/provider-exchange-filters/provider-exchange-filters.go +++ b/cmd/workspace/provider-exchange-filters/provider-exchange-filters.go @@ -186,8 +186,8 @@ func newList() *cobra.Command { var listReq marketplace.ListExchangeFiltersRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list EXCHANGE_ID" cmd.Short = `List exchange filters.` diff --git a/cmd/workspace/provider-exchanges/provider-exchanges.go b/cmd/workspace/provider-exchanges/provider-exchanges.go index 94210836c8..e06f28c1bd 100755 --- a/cmd/workspace/provider-exchanges/provider-exchanges.go +++ b/cmd/workspace/provider-exchanges/provider-exchanges.go @@ -364,8 +364,8 @@ func newList() *cobra.Command { var listReq marketplace.ListExchangesRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List exchanges.` @@ -415,8 +415,8 @@ func newListExchangesForListing() *cobra.Command { var listExchangesForListingReq marketplace.ListExchangesForListingRequest - cmd.Flags().IntVar(&listExchangesForListingReq.PageSize, "page-size", listExchangesForListingReq.PageSize, ``) - cmd.Flags().StringVar(&listExchangesForListingReq.PageToken, "page-token", listExchangesForListingReq.PageToken, ``) + cmd.Flags().IntVar(&listExchangesForListingReq.PageSize, "page-size", listExchangesForListingReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listExchangesForListingReq.PageToken, "page-token", listExchangesForListingReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list-exchanges-for-listing LISTING_ID" cmd.Short = `List exchanges for listing.` @@ -468,8 +468,8 @@ func newListListingsForExchange() *cobra.Command { var listListingsForExchangeReq marketplace.ListListingsForExchangeRequest - cmd.Flags().IntVar(&listListingsForExchangeReq.PageSize, "page-size", listListingsForExchangeReq.PageSize, ``) - cmd.Flags().StringVar(&listListingsForExchangeReq.PageToken, "page-token", listListingsForExchangeReq.PageToken, ``) + cmd.Flags().IntVar(&listListingsForExchangeReq.PageSize, "page-size", listListingsForExchangeReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listListingsForExchangeReq.PageToken, "page-token", listListingsForExchangeReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list-listings-for-exchange EXCHANGE_ID" cmd.Short = `List listings for exchange.` diff --git a/cmd/workspace/provider-files/provider-files.go b/cmd/workspace/provider-files/provider-files.go index 08434c3cac..84447323fc 100755 --- a/cmd/workspace/provider-files/provider-files.go +++ b/cmd/workspace/provider-files/provider-files.go @@ -61,7 +61,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, ``) + cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `Wire name: 'display_name'.`) cmd.Use = "create" cmd.Short = `Create a file.` @@ -258,8 +258,8 @@ func newList() *cobra.Command { cmd.Flags().Var(&listJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List files.` diff --git a/cmd/workspace/provider-listings/provider-listings.go b/cmd/workspace/provider-listings/provider-listings.go index 5bac5d5c7d..55cfd6bdce 100755 --- a/cmd/workspace/provider-listings/provider-listings.go +++ b/cmd/workspace/provider-listings/provider-listings.go @@ -253,8 +253,8 @@ func newList() *cobra.Command { var listReq marketplace.GetListingsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List listings.` diff --git a/cmd/workspace/provider-personalization-requests/provider-personalization-requests.go b/cmd/workspace/provider-personalization-requests/provider-personalization-requests.go index f88cfa2407..3fe21b2d9a 100755 --- a/cmd/workspace/provider-personalization-requests/provider-personalization-requests.go +++ b/cmd/workspace/provider-personalization-requests/provider-personalization-requests.go @@ -56,8 +56,8 @@ func newList() *cobra.Command { var listReq marketplace.ListAllPersonalizationRequestsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `All personalization requests across all listings.` @@ -111,7 +111,7 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Reason, "reason", updateReq.Reason, ``) + cmd.Flags().StringVar(&updateReq.Reason, "reason", updateReq.Reason, `Wire name: 'reason'.`) // TODO: complex arg: share cmd.Use = "update LISTING_ID REQUEST_ID STATUS" diff --git a/cmd/workspace/provider-provider-analytics-dashboards/provider-provider-analytics-dashboards.go b/cmd/workspace/provider-provider-analytics-dashboards/provider-provider-analytics-dashboards.go index 809256d7af..f4443b16e7 100755 --- a/cmd/workspace/provider-provider-analytics-dashboards/provider-provider-analytics-dashboards.go +++ b/cmd/workspace/provider-provider-analytics-dashboards/provider-provider-analytics-dashboards.go @@ -181,7 +181,7 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().Int64Var(&updateReq.Version, "version", updateReq.Version, `this is the version of the dashboard template we want to update our user to current expectation is that it should be equal to latest version of the dashboard template.`) + cmd.Flags().Int64Var(&updateReq.Version, "version", updateReq.Version, `this is the version of the dashboard template we want to update our user to current expectation is that it should be equal to latest version of the dashboard template. Wire name: 'version'.`) cmd.Use = "update ID" cmd.Short = `Update provider analytics dashboard.` diff --git a/cmd/workspace/provider-providers/provider-providers.go b/cmd/workspace/provider-providers/provider-providers.go index 872b998730..a06a696ab3 100755 --- a/cmd/workspace/provider-providers/provider-providers.go +++ b/cmd/workspace/provider-providers/provider-providers.go @@ -252,8 +252,8 @@ func newList() *cobra.Command { var listReq marketplace.ListProvidersRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List providers.` diff --git a/cmd/workspace/providers/providers.go b/cmd/workspace/providers/providers.go index 1a1b31ef5f..808d4eba06 100755 --- a/cmd/workspace/providers/providers.go +++ b/cmd/workspace/providers/providers.go @@ -65,8 +65,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `Description about the provider.`) - cmd.Flags().StringVar(&createReq.RecipientProfileStr, "recipient-profile-str", createReq.RecipientProfileStr, `This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS** or not provided.`) + cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `Description about the provider. Wire name: 'comment'.`) + cmd.Flags().StringVar(&createReq.RecipientProfileStr, "recipient-profile-str", createReq.RecipientProfileStr, `This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS** or not provided. Wire name: 'recipient_profile_str'.`) cmd.Use = "create NAME AUTHENTICATION_TYPE" cmd.Short = `Create an auth provider.` @@ -294,9 +294,9 @@ func newList() *cobra.Command { var listReq sharing.ListProvidersRequest - cmd.Flags().StringVar(&listReq.DataProviderGlobalMetastoreId, "data-provider-global-metastore-id", listReq.DataProviderGlobalMetastoreId, `If not provided, all providers will be returned.`) - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of providers to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().StringVar(&listReq.DataProviderGlobalMetastoreId, "data-provider-global-metastore-id", listReq.DataProviderGlobalMetastoreId, `If not provided, all providers will be returned. Wire name: 'data_provider_global_metastore_id'.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of providers to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List providers.` @@ -349,10 +349,10 @@ func newListProviderShareAssets() *cobra.Command { var listProviderShareAssetsReq sharing.ListProviderShareAssetsRequest - cmd.Flags().IntVar(&listProviderShareAssetsReq.FunctionMaxResults, "function-max-results", listProviderShareAssetsReq.FunctionMaxResults, `Maximum number of functions to return.`) - cmd.Flags().IntVar(&listProviderShareAssetsReq.NotebookMaxResults, "notebook-max-results", listProviderShareAssetsReq.NotebookMaxResults, `Maximum number of notebooks to return.`) - cmd.Flags().IntVar(&listProviderShareAssetsReq.TableMaxResults, "table-max-results", listProviderShareAssetsReq.TableMaxResults, `Maximum number of tables to return.`) - cmd.Flags().IntVar(&listProviderShareAssetsReq.VolumeMaxResults, "volume-max-results", listProviderShareAssetsReq.VolumeMaxResults, `Maximum number of volumes to return.`) + cmd.Flags().IntVar(&listProviderShareAssetsReq.FunctionMaxResults, "function-max-results", listProviderShareAssetsReq.FunctionMaxResults, `Maximum number of functions to return. Wire name: 'function_max_results'.`) + cmd.Flags().IntVar(&listProviderShareAssetsReq.NotebookMaxResults, "notebook-max-results", listProviderShareAssetsReq.NotebookMaxResults, `Maximum number of notebooks to return. Wire name: 'notebook_max_results'.`) + cmd.Flags().IntVar(&listProviderShareAssetsReq.TableMaxResults, "table-max-results", listProviderShareAssetsReq.TableMaxResults, `Maximum number of tables to return. Wire name: 'table_max_results'.`) + cmd.Flags().IntVar(&listProviderShareAssetsReq.VolumeMaxResults, "volume-max-results", listProviderShareAssetsReq.VolumeMaxResults, `Maximum number of volumes to return. Wire name: 'volume_max_results'.`) cmd.Use = "list-provider-share-assets PROVIDER_NAME SHARE_NAME" cmd.Short = `List assets by provider share.` @@ -413,8 +413,8 @@ func newListShares() *cobra.Command { var listSharesReq sharing.ListSharesRequest - cmd.Flags().IntVar(&listSharesReq.MaxResults, "max-results", listSharesReq.MaxResults, `Maximum number of shares to return.`) - cmd.Flags().StringVar(&listSharesReq.PageToken, "page-token", listSharesReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().IntVar(&listSharesReq.MaxResults, "max-results", listSharesReq.MaxResults, `Maximum number of shares to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listSharesReq.PageToken, "page-token", listSharesReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list-shares NAME" cmd.Short = `List shares by Provider.` @@ -486,10 +486,10 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `Description about the provider.`) - cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the provider.`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of Provider owner.`) - cmd.Flags().StringVar(&updateReq.RecipientProfileStr, "recipient-profile-str", updateReq.RecipientProfileStr, `This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS** or not provided.`) + cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `Description about the provider. Wire name: 'comment'.`) + cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the provider. Wire name: 'new_name'.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of Provider owner. Wire name: 'owner'.`) + cmd.Flags().StringVar(&updateReq.RecipientProfileStr, "recipient-profile-str", updateReq.RecipientProfileStr, `This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS** or not provided. Wire name: 'recipient_profile_str'.`) cmd.Use = "update NAME" cmd.Short = `Update a provider.` diff --git a/cmd/workspace/quality-monitor-v2/quality-monitor-v2.go b/cmd/workspace/quality-monitor-v2/quality-monitor-v2.go index 689dccd4c8..a2fd3fde5d 100755 --- a/cmd/workspace/quality-monitor-v2/quality-monitor-v2.go +++ b/cmd/workspace/quality-monitor-v2/quality-monitor-v2.go @@ -261,8 +261,8 @@ func newListQualityMonitor() *cobra.Command { var listQualityMonitorReq qualitymonitorv2.ListQualityMonitorRequest - cmd.Flags().IntVar(&listQualityMonitorReq.PageSize, "page-size", listQualityMonitorReq.PageSize, ``) - cmd.Flags().StringVar(&listQualityMonitorReq.PageToken, "page-token", listQualityMonitorReq.PageToken, ``) + cmd.Flags().IntVar(&listQualityMonitorReq.PageSize, "page-size", listQualityMonitorReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listQualityMonitorReq.PageToken, "page-token", listQualityMonitorReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list-quality-monitor" cmd.Short = `List quality monitors.` diff --git a/cmd/workspace/quality-monitors/quality-monitors.go b/cmd/workspace/quality-monitors/quality-monitors.go index 80a07aaf59..acdc61c887 100755 --- a/cmd/workspace/quality-monitors/quality-monitors.go +++ b/cmd/workspace/quality-monitors/quality-monitors.go @@ -136,18 +136,18 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.BaselineTableName, "baseline-table-name", createReq.BaselineTableName, `[Create:OPT Update:OPT] Baseline table name.`) + cmd.Flags().StringVar(&createReq.BaselineTableName, "baseline-table-name", createReq.BaselineTableName, `[Create:OPT Update:OPT] Baseline table name. Wire name: 'baseline_table_name'.`) // TODO: array: custom_metrics // TODO: complex arg: data_classification_config // TODO: complex arg: inference_log - cmd.Flags().StringVar(&createReq.LatestMonitorFailureMsg, "latest-monitor-failure-msg", createReq.LatestMonitorFailureMsg, `[Create:ERR Update:IGN] The latest error message for a monitor failure.`) + cmd.Flags().StringVar(&createReq.LatestMonitorFailureMsg, "latest-monitor-failure-msg", createReq.LatestMonitorFailureMsg, `[Create:ERR Update:IGN] The latest error message for a monitor failure. Wire name: 'latest_monitor_failure_msg'.`) // TODO: complex arg: notifications // TODO: complex arg: schedule - cmd.Flags().BoolVar(&createReq.SkipBuiltinDashboard, "skip-builtin-dashboard", createReq.SkipBuiltinDashboard, `Whether to skip creating a default dashboard summarizing data quality metrics.`) + cmd.Flags().BoolVar(&createReq.SkipBuiltinDashboard, "skip-builtin-dashboard", createReq.SkipBuiltinDashboard, `Whether to skip creating a default dashboard summarizing data quality metrics. Wire name: 'skip_builtin_dashboard'.`) // TODO: array: slicing_exprs // TODO: complex arg: snapshot // TODO: complex arg: time_series - cmd.Flags().StringVar(&createReq.WarehouseId, "warehouse-id", createReq.WarehouseId, `Optional argument to specify the warehouse for dashboard creation.`) + cmd.Flags().StringVar(&createReq.WarehouseId, "warehouse-id", createReq.WarehouseId, `Optional argument to specify the warehouse for dashboard creation. Wire name: 'warehouse_id'.`) cmd.Use = "create TABLE_NAME OUTPUT_SCHEMA_NAME ASSETS_DIR" cmd.Short = `Create a table monitor.` @@ -523,7 +523,7 @@ func newRegenerateDashboard() *cobra.Command { cmd.Flags().Var(®enerateDashboardJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(®enerateDashboardReq.WarehouseId, "warehouse-id", regenerateDashboardReq.WarehouseId, `Optional argument to specify the warehouse for dashboard regeneration.`) + cmd.Flags().StringVar(®enerateDashboardReq.WarehouseId, "warehouse-id", regenerateDashboardReq.WarehouseId, `Optional argument to specify the warehouse for dashboard regeneration. Wire name: 'warehouse_id'.`) cmd.Use = "regenerate-dashboard TABLE_NAME" cmd.Short = `Regenerate a monitoring dashboard.` @@ -677,12 +677,12 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.BaselineTableName, "baseline-table-name", updateReq.BaselineTableName, `[Create:OPT Update:OPT] Baseline table name.`) + cmd.Flags().StringVar(&updateReq.BaselineTableName, "baseline-table-name", updateReq.BaselineTableName, `[Create:OPT Update:OPT] Baseline table name. Wire name: 'baseline_table_name'.`) // TODO: array: custom_metrics - cmd.Flags().StringVar(&updateReq.DashboardId, "dashboard-id", updateReq.DashboardId, `[Create:ERR Update:OPT] Id of dashboard that visualizes the computed metrics.`) + cmd.Flags().StringVar(&updateReq.DashboardId, "dashboard-id", updateReq.DashboardId, `[Create:ERR Update:OPT] Id of dashboard that visualizes the computed metrics. Wire name: 'dashboard_id'.`) // TODO: complex arg: data_classification_config // TODO: complex arg: inference_log - cmd.Flags().StringVar(&updateReq.LatestMonitorFailureMsg, "latest-monitor-failure-msg", updateReq.LatestMonitorFailureMsg, `[Create:ERR Update:IGN] The latest error message for a monitor failure.`) + cmd.Flags().StringVar(&updateReq.LatestMonitorFailureMsg, "latest-monitor-failure-msg", updateReq.LatestMonitorFailureMsg, `[Create:ERR Update:IGN] The latest error message for a monitor failure. Wire name: 'latest_monitor_failure_msg'.`) // TODO: complex arg: notifications // TODO: complex arg: schedule // TODO: array: slicing_exprs diff --git a/cmd/workspace/queries-legacy/queries-legacy.go b/cmd/workspace/queries-legacy/queries-legacy.go index e52fa6d81c..35daf57c91 100755 --- a/cmd/workspace/queries-legacy/queries-legacy.go +++ b/cmd/workspace/queries-legacy/queries-legacy.go @@ -68,13 +68,13 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.DataSourceId, "data-source-id", createReq.DataSourceId, `Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID.`) - cmd.Flags().StringVar(&createReq.Description, "description", createReq.Description, `General description that conveys additional information about this query such as usage notes.`) - cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `The title of this query that appears in list views, widget headings, and on the query page.`) + cmd.Flags().StringVar(&createReq.DataSourceId, "data-source-id", createReq.DataSourceId, `Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID. Wire name: 'data_source_id'.`) + cmd.Flags().StringVar(&createReq.Description, "description", createReq.Description, `General description that conveys additional information about this query such as usage notes. Wire name: 'description'.`) + cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `The title of this query that appears in list views, widget headings, and on the query page. Wire name: 'name'.`) // TODO: any: options - cmd.Flags().StringVar(&createReq.Parent, "parent", createReq.Parent, `The identifier of the workspace folder containing the object.`) - cmd.Flags().StringVar(&createReq.Query, "query", createReq.Query, `The text of the query to be run.`) - cmd.Flags().Var(&createReq.RunAsRole, "run-as-role", `Sets the **Run as** role for the object. Supported values: [owner, viewer]`) + cmd.Flags().StringVar(&createReq.Parent, "parent", createReq.Parent, `The identifier of the workspace folder containing the object. Wire name: 'parent'.`) + cmd.Flags().StringVar(&createReq.Query, "query", createReq.Query, `The text of the query to be run. Wire name: 'query'.`) + cmd.Flags().Var(&createReq.RunAsRole, "run-as-role", `Sets the **Run as** role for the object. Supported values: [owner, viewer]. Wire name: 'run_as_role'.`) // TODO: array: tags cmd.Use = "create" @@ -273,10 +273,10 @@ func newList() *cobra.Command { var listReq sql.ListQueriesLegacyRequest - cmd.Flags().StringVar(&listReq.Order, "order", listReq.Order, `Name of query attribute to order by.`) - cmd.Flags().IntVar(&listReq.Page, "page", listReq.Page, `Page number to retrieve.`) - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Number of queries to return per page.`) - cmd.Flags().StringVar(&listReq.Q, "q", listReq.Q, `Full text search term.`) + cmd.Flags().StringVar(&listReq.Order, "order", listReq.Order, `Name of query attribute to order by. Wire name: 'order'.`) + cmd.Flags().IntVar(&listReq.Page, "page", listReq.Page, `Page number to retrieve. Wire name: 'page'.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Number of queries to return per page. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.Q, "q", listReq.Q, `Full text search term. Wire name: 'q'.`) cmd.Use = "list" cmd.Short = `Get a list of queries.` @@ -397,12 +397,12 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.DataSourceId, "data-source-id", updateReq.DataSourceId, `Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID.`) - cmd.Flags().StringVar(&updateReq.Description, "description", updateReq.Description, `General description that conveys additional information about this query such as usage notes.`) - cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `The title of this query that appears in list views, widget headings, and on the query page.`) + cmd.Flags().StringVar(&updateReq.DataSourceId, "data-source-id", updateReq.DataSourceId, `Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID. Wire name: 'data_source_id'.`) + cmd.Flags().StringVar(&updateReq.Description, "description", updateReq.Description, `General description that conveys additional information about this query such as usage notes. Wire name: 'description'.`) + cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `The title of this query that appears in list views, widget headings, and on the query page. Wire name: 'name'.`) // TODO: any: options - cmd.Flags().StringVar(&updateReq.Query, "query", updateReq.Query, `The text of the query to be run.`) - cmd.Flags().Var(&updateReq.RunAsRole, "run-as-role", `Sets the **Run as** role for the object. Supported values: [owner, viewer]`) + cmd.Flags().StringVar(&updateReq.Query, "query", updateReq.Query, `The text of the query to be run. Wire name: 'query'.`) + cmd.Flags().Var(&updateReq.RunAsRole, "run-as-role", `Sets the **Run as** role for the object. Supported values: [owner, viewer]. Wire name: 'run_as_role'.`) // TODO: array: tags cmd.Use = "update QUERY_ID" diff --git a/cmd/workspace/queries/queries.go b/cmd/workspace/queries/queries.go index 3cca60bdb3..52e734631c 100755 --- a/cmd/workspace/queries/queries.go +++ b/cmd/workspace/queries/queries.go @@ -65,7 +65,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&createReq.AutoResolveDisplayName, "auto-resolve-display-name", createReq.AutoResolveDisplayName, `If true, automatically resolve query display name conflicts.`) + cmd.Flags().BoolVar(&createReq.AutoResolveDisplayName, "auto-resolve-display-name", createReq.AutoResolveDisplayName, `If true, automatically resolve query display name conflicts. Wire name: 'auto_resolve_display_name'.`) // TODO: complex arg: query cmd.Use = "create" @@ -265,8 +265,8 @@ func newList() *cobra.Command { var listReq sql.ListQueriesRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List queries.` @@ -318,8 +318,8 @@ func newListVisualizations() *cobra.Command { var listVisualizationsReq sql.ListVisualizationsForQueryRequest - cmd.Flags().IntVar(&listVisualizationsReq.PageSize, "page-size", listVisualizationsReq.PageSize, ``) - cmd.Flags().StringVar(&listVisualizationsReq.PageToken, "page-token", listVisualizationsReq.PageToken, ``) + cmd.Flags().IntVar(&listVisualizationsReq.PageSize, "page-size", listVisualizationsReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listVisualizationsReq.PageToken, "page-token", listVisualizationsReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list-visualizations ID" cmd.Short = `List visualizations on a query.` @@ -389,7 +389,7 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&updateReq.AutoResolveDisplayName, "auto-resolve-display-name", updateReq.AutoResolveDisplayName, `If true, automatically resolve alert display name conflicts.`) + cmd.Flags().BoolVar(&updateReq.AutoResolveDisplayName, "auto-resolve-display-name", updateReq.AutoResolveDisplayName, `If true, automatically resolve alert display name conflicts. Wire name: 'auto_resolve_display_name'.`) // TODO: complex arg: query cmd.Use = "update ID UPDATE_MASK" diff --git a/cmd/workspace/query-history/query-history.go b/cmd/workspace/query-history/query-history.go index 8854a0b236..2a1306711e 100755 --- a/cmd/workspace/query-history/query-history.go +++ b/cmd/workspace/query-history/query-history.go @@ -53,9 +53,9 @@ func newList() *cobra.Command { var listReq sql.ListQueryHistoryRequest // TODO: complex arg: filter_by - cmd.Flags().BoolVar(&listReq.IncludeMetrics, "include-metrics", listReq.IncludeMetrics, `Whether to include the query metrics with each query.`) - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Limit the number of results returned in one page.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A token that can be used to get the next page of results.`) + cmd.Flags().BoolVar(&listReq.IncludeMetrics, "include-metrics", listReq.IncludeMetrics, `Whether to include the query metrics with each query. Wire name: 'include_metrics'.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Limit the number of results returned in one page. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A token that can be used to get the next page of results. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List Queries.` diff --git a/cmd/workspace/query-visualizations-legacy/query-visualizations-legacy.go b/cmd/workspace/query-visualizations-legacy/query-visualizations-legacy.go index f66fe2b615..60abe902af 100755 --- a/cmd/workspace/query-visualizations-legacy/query-visualizations-legacy.go +++ b/cmd/workspace/query-visualizations-legacy/query-visualizations-legacy.go @@ -69,8 +69,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Description, "description", createReq.Description, `A short description of this visualization.`) - cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `The name of the visualization that appears on dashboards and the query screen.`) + cmd.Flags().StringVar(&createReq.Description, "description", createReq.Description, `A short description of this visualization. Wire name: 'description'.`) + cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `The name of the visualization that appears on dashboards and the query screen. Wire name: 'name'.`) cmd.Use = "create" cmd.Short = `Add visualization to a query.` @@ -202,14 +202,14 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.CreatedAt, "created-at", updateReq.CreatedAt, ``) - cmd.Flags().StringVar(&updateReq.Description, "description", updateReq.Description, `A short description of this visualization.`) - cmd.Flags().StringVar(&updateReq.Id, "id", updateReq.Id, `The UUID for this visualization.`) - cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `The name of the visualization that appears on dashboards and the query screen.`) + cmd.Flags().StringVar(&updateReq.CreatedAt, "created-at", updateReq.CreatedAt, `Wire name: 'created_at'.`) + cmd.Flags().StringVar(&updateReq.Description, "description", updateReq.Description, `A short description of this visualization. Wire name: 'description'.`) + cmd.Flags().StringVar(&updateReq.Id, "id", updateReq.Id, `The UUID for this visualization. Wire name: 'id'.`) + cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `The name of the visualization that appears on dashboards and the query screen. Wire name: 'name'.`) // TODO: any: options // TODO: complex arg: query - cmd.Flags().StringVar(&updateReq.Type, "type", updateReq.Type, `The type of visualization: chart, table, pivot table, and so on.`) - cmd.Flags().StringVar(&updateReq.UpdatedAt, "updated-at", updateReq.UpdatedAt, ``) + cmd.Flags().StringVar(&updateReq.Type, "type", updateReq.Type, `The type of visualization: chart, table, pivot table, and so on. Wire name: 'type'.`) + cmd.Flags().StringVar(&updateReq.UpdatedAt, "updated-at", updateReq.UpdatedAt, `Wire name: 'updated_at'.`) cmd.Use = "update" cmd.Short = `Edit existing visualization.` diff --git a/cmd/workspace/recipient-federation-policies/recipient-federation-policies.go b/cmd/workspace/recipient-federation-policies/recipient-federation-policies.go index 26e123673d..d055cdb6a3 100755 --- a/cmd/workspace/recipient-federation-policies/recipient-federation-policies.go +++ b/cmd/workspace/recipient-federation-policies/recipient-federation-policies.go @@ -83,8 +83,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Policy.Comment, "comment", createReq.Policy.Comment, `Description of the policy.`) - cmd.Flags().StringVar(&createReq.Policy.Name, "name", createReq.Policy.Name, `Name of the federation policy.`) + cmd.Flags().StringVar(&createReq.Policy.Comment, "comment", createReq.Policy.Comment, `Description of the policy. Wire name: 'comment'.`) + cmd.Flags().StringVar(&createReq.Policy.Name, "name", createReq.Policy.Name, `Name of the federation policy. Wire name: 'name'.`) // TODO: complex arg: oidc_policy cmd.Use = "create RECIPIENT_NAME" @@ -302,8 +302,8 @@ func newList() *cobra.Command { var listReq sharing.ListFederationPoliciesRequest - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, ``) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Wire name: 'page_token'.`) cmd.Use = "list RECIPIENT_NAME" cmd.Short = `List recipient federation policies.` diff --git a/cmd/workspace/recipients/recipients.go b/cmd/workspace/recipients/recipients.go index cb63e56007..58fc041cee 100755 --- a/cmd/workspace/recipients/recipients.go +++ b/cmd/workspace/recipients/recipients.go @@ -79,13 +79,13 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `Description about the recipient.`) - cmd.Flags().StringVar(&createReq.DataRecipientGlobalMetastoreId, "data-recipient-global-metastore-id", createReq.DataRecipientGlobalMetastoreId, `The global Unity Catalog metastore id provided by the data recipient.`) - cmd.Flags().Int64Var(&createReq.ExpirationTime, "expiration-time", createReq.ExpirationTime, `Expiration timestamp of the token, in epoch milliseconds.`) + cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `Description about the recipient. Wire name: 'comment'.`) + cmd.Flags().StringVar(&createReq.DataRecipientGlobalMetastoreId, "data-recipient-global-metastore-id", createReq.DataRecipientGlobalMetastoreId, `The global Unity Catalog metastore id provided by the data recipient. Wire name: 'data_recipient_global_metastore_id'.`) + cmd.Flags().Int64Var(&createReq.ExpirationTime, "expiration-time", createReq.ExpirationTime, `Expiration timestamp of the token, in epoch milliseconds. Wire name: 'expiration_time'.`) // TODO: complex arg: ip_access_list - cmd.Flags().StringVar(&createReq.Owner, "owner", createReq.Owner, `Username of the recipient owner.`) + cmd.Flags().StringVar(&createReq.Owner, "owner", createReq.Owner, `Username of the recipient owner. Wire name: 'owner'.`) // TODO: complex arg: properties_kvpairs - cmd.Flags().StringVar(&createReq.SharingCode, "sharing-code", createReq.SharingCode, `The one-time sharing code provided by the data recipient.`) + cmd.Flags().StringVar(&createReq.SharingCode, "sharing-code", createReq.SharingCode, `The one-time sharing code provided by the data recipient. Wire name: 'sharing_code'.`) cmd.Use = "create NAME AUTHENTICATION_TYPE" cmd.Short = `Create a share recipient.` @@ -290,9 +290,9 @@ func newList() *cobra.Command { var listReq sharing.ListRecipientsRequest - cmd.Flags().StringVar(&listReq.DataRecipientGlobalMetastoreId, "data-recipient-global-metastore-id", listReq.DataRecipientGlobalMetastoreId, `If not provided, all recipients will be returned.`) - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of recipients to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().StringVar(&listReq.DataRecipientGlobalMetastoreId, "data-recipient-global-metastore-id", listReq.DataRecipientGlobalMetastoreId, `If not provided, all recipients will be returned. Wire name: 'data_recipient_global_metastore_id'.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of recipients to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List share recipients.` @@ -435,8 +435,8 @@ func newSharePermissions() *cobra.Command { var sharePermissionsReq sharing.SharePermissionsRequest - cmd.Flags().IntVar(&sharePermissionsReq.MaxResults, "max-results", sharePermissionsReq.MaxResults, `Maximum number of permissions to return.`) - cmd.Flags().StringVar(&sharePermissionsReq.PageToken, "page-token", sharePermissionsReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().IntVar(&sharePermissionsReq.MaxResults, "max-results", sharePermissionsReq.MaxResults, `Maximum number of permissions to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&sharePermissionsReq.PageToken, "page-token", sharePermissionsReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "share-permissions NAME" cmd.Short = `Get recipient share permissions.` @@ -498,11 +498,11 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `Description about the recipient.`) - cmd.Flags().Int64Var(&updateReq.ExpirationTime, "expiration-time", updateReq.ExpirationTime, `Expiration timestamp of the token, in epoch milliseconds.`) + cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `Description about the recipient. Wire name: 'comment'.`) + cmd.Flags().Int64Var(&updateReq.ExpirationTime, "expiration-time", updateReq.ExpirationTime, `Expiration timestamp of the token, in epoch milliseconds. Wire name: 'expiration_time'.`) // TODO: complex arg: ip_access_list - cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the recipient.`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of the recipient owner.`) + cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the recipient. Wire name: 'new_name'.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of the recipient owner. Wire name: 'owner'.`) // TODO: complex arg: properties_kvpairs cmd.Use = "update NAME" diff --git a/cmd/workspace/registered-models/registered-models.go b/cmd/workspace/registered-models/registered-models.go index cf75be001b..7612c8f89e 100755 --- a/cmd/workspace/registered-models/registered-models.go +++ b/cmd/workspace/registered-models/registered-models.go @@ -92,19 +92,19 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: aliases - cmd.Flags().BoolVar(&createReq.BrowseOnly, "browse-only", createReq.BrowseOnly, `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.`) - cmd.Flags().StringVar(&createReq.CatalogName, "catalog-name", createReq.CatalogName, `The name of the catalog where the schema and the registered model reside.`) - cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `The comment attached to the registered model.`) - cmd.Flags().Int64Var(&createReq.CreatedAt, "created-at", createReq.CreatedAt, `Creation timestamp of the registered model in milliseconds since the Unix epoch.`) - cmd.Flags().StringVar(&createReq.CreatedBy, "created-by", createReq.CreatedBy, `The identifier of the user who created the registered model.`) - cmd.Flags().StringVar(&createReq.FullName, "full-name", createReq.FullName, `The three-level (fully qualified) name of the registered model.`) - cmd.Flags().StringVar(&createReq.MetastoreId, "metastore-id", createReq.MetastoreId, `The unique identifier of the metastore.`) - cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `The name of the registered model.`) - cmd.Flags().StringVar(&createReq.Owner, "owner", createReq.Owner, `The identifier of the user who owns the registered model.`) - cmd.Flags().StringVar(&createReq.SchemaName, "schema-name", createReq.SchemaName, `The name of the schema where the registered model resides.`) - cmd.Flags().StringVar(&createReq.StorageLocation, "storage-location", createReq.StorageLocation, `The storage location on the cloud under which model version data files are stored.`) - cmd.Flags().Int64Var(&createReq.UpdatedAt, "updated-at", createReq.UpdatedAt, `Last-update timestamp of the registered model in milliseconds since the Unix epoch.`) - cmd.Flags().StringVar(&createReq.UpdatedBy, "updated-by", createReq.UpdatedBy, `The identifier of the user who updated the registered model last time.`) + cmd.Flags().BoolVar(&createReq.BrowseOnly, "browse-only", createReq.BrowseOnly, `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. Wire name: 'browse_only'.`) + cmd.Flags().StringVar(&createReq.CatalogName, "catalog-name", createReq.CatalogName, `The name of the catalog where the schema and the registered model reside. Wire name: 'catalog_name'.`) + cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `The comment attached to the registered model. Wire name: 'comment'.`) + cmd.Flags().Int64Var(&createReq.CreatedAt, "created-at", createReq.CreatedAt, `Creation timestamp of the registered model in milliseconds since the Unix epoch. Wire name: 'created_at'.`) + cmd.Flags().StringVar(&createReq.CreatedBy, "created-by", createReq.CreatedBy, `The identifier of the user who created the registered model. Wire name: 'created_by'.`) + cmd.Flags().StringVar(&createReq.FullName, "full-name", createReq.FullName, `The three-level (fully qualified) name of the registered model. Wire name: 'full_name'.`) + cmd.Flags().StringVar(&createReq.MetastoreId, "metastore-id", createReq.MetastoreId, `The unique identifier of the metastore. Wire name: 'metastore_id'.`) + cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `The name of the registered model. Wire name: 'name'.`) + cmd.Flags().StringVar(&createReq.Owner, "owner", createReq.Owner, `The identifier of the user who owns the registered model. Wire name: 'owner'.`) + cmd.Flags().StringVar(&createReq.SchemaName, "schema-name", createReq.SchemaName, `The name of the schema where the registered model resides. Wire name: 'schema_name'.`) + cmd.Flags().StringVar(&createReq.StorageLocation, "storage-location", createReq.StorageLocation, `The storage location on the cloud under which model version data files are stored. Wire name: 'storage_location'.`) + cmd.Flags().Int64Var(&createReq.UpdatedAt, "updated-at", createReq.UpdatedAt, `Last-update timestamp of the registered model in milliseconds since the Unix epoch. Wire name: 'updated_at'.`) + cmd.Flags().StringVar(&createReq.UpdatedBy, "updated-by", createReq.UpdatedBy, `The identifier of the user who updated the registered model last time. Wire name: 'updated_by'.`) cmd.Use = "create" cmd.Short = `Create a Registered Model.` @@ -318,8 +318,8 @@ func newGet() *cobra.Command { var getReq catalog.GetRegisteredModelRequest - cmd.Flags().BoolVar(&getReq.IncludeAliases, "include-aliases", getReq.IncludeAliases, `Whether to include registered model aliases in the response.`) - cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include registered models in the response for which the principal can only access selective metadata for.`) + cmd.Flags().BoolVar(&getReq.IncludeAliases, "include-aliases", getReq.IncludeAliases, `Whether to include registered model aliases in the response. Wire name: 'include_aliases'.`) + cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include registered models in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) cmd.Use = "get FULL_NAME" cmd.Short = `Get a Registered Model.` @@ -394,11 +394,11 @@ func newList() *cobra.Command { var listReq catalog.ListRegisteredModelsRequest - cmd.Flags().StringVar(&listReq.CatalogName, "catalog-name", listReq.CatalogName, `The identifier of the catalog under which to list registered models.`) - cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include registered models in the response for which the principal can only access selective metadata for.`) - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Max number of registered models to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque token to send for the next page of results (pagination).`) - cmd.Flags().StringVar(&listReq.SchemaName, "schema-name", listReq.SchemaName, `The identifier of the schema under which to list registered models.`) + cmd.Flags().StringVar(&listReq.CatalogName, "catalog-name", listReq.CatalogName, `The identifier of the catalog under which to list registered models. Wire name: 'catalog_name'.`) + cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include registered models in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Max number of registered models to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque token to send for the next page of results (pagination). Wire name: 'page_token'.`) + cmd.Flags().StringVar(&listReq.SchemaName, "schema-name", listReq.SchemaName, `The identifier of the schema under which to list registered models. Wire name: 'schema_name'.`) cmd.Use = "list" cmd.Short = `List Registered Models.` @@ -561,19 +561,19 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: aliases - cmd.Flags().BoolVar(&updateReq.BrowseOnly, "browse-only", updateReq.BrowseOnly, `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.`) - cmd.Flags().StringVar(&updateReq.CatalogName, "catalog-name", updateReq.CatalogName, `The name of the catalog where the schema and the registered model reside.`) - cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `The comment attached to the registered model.`) - cmd.Flags().Int64Var(&updateReq.CreatedAt, "created-at", updateReq.CreatedAt, `Creation timestamp of the registered model in milliseconds since the Unix epoch.`) - cmd.Flags().StringVar(&updateReq.CreatedBy, "created-by", updateReq.CreatedBy, `The identifier of the user who created the registered model.`) - cmd.Flags().StringVar(&updateReq.MetastoreId, "metastore-id", updateReq.MetastoreId, `The unique identifier of the metastore.`) - cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `The name of the registered model.`) - cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the registered model.`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `The identifier of the user who owns the registered model.`) - cmd.Flags().StringVar(&updateReq.SchemaName, "schema-name", updateReq.SchemaName, `The name of the schema where the registered model resides.`) - cmd.Flags().StringVar(&updateReq.StorageLocation, "storage-location", updateReq.StorageLocation, `The storage location on the cloud under which model version data files are stored.`) - cmd.Flags().Int64Var(&updateReq.UpdatedAt, "updated-at", updateReq.UpdatedAt, `Last-update timestamp of the registered model in milliseconds since the Unix epoch.`) - cmd.Flags().StringVar(&updateReq.UpdatedBy, "updated-by", updateReq.UpdatedBy, `The identifier of the user who updated the registered model last time.`) + cmd.Flags().BoolVar(&updateReq.BrowseOnly, "browse-only", updateReq.BrowseOnly, `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. Wire name: 'browse_only'.`) + cmd.Flags().StringVar(&updateReq.CatalogName, "catalog-name", updateReq.CatalogName, `The name of the catalog where the schema and the registered model reside. Wire name: 'catalog_name'.`) + cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `The comment attached to the registered model. Wire name: 'comment'.`) + cmd.Flags().Int64Var(&updateReq.CreatedAt, "created-at", updateReq.CreatedAt, `Creation timestamp of the registered model in milliseconds since the Unix epoch. Wire name: 'created_at'.`) + cmd.Flags().StringVar(&updateReq.CreatedBy, "created-by", updateReq.CreatedBy, `The identifier of the user who created the registered model. Wire name: 'created_by'.`) + cmd.Flags().StringVar(&updateReq.MetastoreId, "metastore-id", updateReq.MetastoreId, `The unique identifier of the metastore. Wire name: 'metastore_id'.`) + cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `The name of the registered model. Wire name: 'name'.`) + cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the registered model. Wire name: 'new_name'.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `The identifier of the user who owns the registered model. Wire name: 'owner'.`) + cmd.Flags().StringVar(&updateReq.SchemaName, "schema-name", updateReq.SchemaName, `The name of the schema where the registered model resides. Wire name: 'schema_name'.`) + cmd.Flags().StringVar(&updateReq.StorageLocation, "storage-location", updateReq.StorageLocation, `The storage location on the cloud under which model version data files are stored. Wire name: 'storage_location'.`) + cmd.Flags().Int64Var(&updateReq.UpdatedAt, "updated-at", updateReq.UpdatedAt, `Last-update timestamp of the registered model in milliseconds since the Unix epoch. Wire name: 'updated_at'.`) + cmd.Flags().StringVar(&updateReq.UpdatedBy, "updated-by", updateReq.UpdatedBy, `The identifier of the user who updated the registered model last time. Wire name: 'updated_by'.`) cmd.Use = "update FULL_NAME" cmd.Short = `Update a Registered Model.` diff --git a/cmd/workspace/repos/repos.go b/cmd/workspace/repos/repos.go index 9c36e0a737..64a4239b2c 100755 --- a/cmd/workspace/repos/repos.go +++ b/cmd/workspace/repos/repos.go @@ -74,7 +74,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Path, "path", createReq.Path, `Desired path for the repo in the workspace.`) + cmd.Flags().StringVar(&createReq.Path, "path", createReq.Path, `Desired path for the repo in the workspace. Wire name: 'path'.`) // TODO: complex arg: sparse_checkout cmd.Use = "create URL PROVIDER" @@ -442,8 +442,8 @@ func newList() *cobra.Command { var listReq workspace.ListReposRequest - cmd.Flags().StringVar(&listReq.NextPageToken, "next-page-token", listReq.NextPageToken, `Token used to get the next page of results.`) - cmd.Flags().StringVar(&listReq.PathPrefix, "path-prefix", listReq.PathPrefix, `Filters repos that have paths starting with the given path prefix.`) + cmd.Flags().StringVar(&listReq.NextPageToken, "next-page-token", listReq.NextPageToken, `Token used to get the next page of results. Wire name: 'next_page_token'.`) + cmd.Flags().StringVar(&listReq.PathPrefix, "path-prefix", listReq.PathPrefix, `Filters repos that have paths starting with the given path prefix. Wire name: 'path_prefix'.`) cmd.Use = "list" cmd.Short = `Get repos.` @@ -584,9 +584,9 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Branch, "branch", updateReq.Branch, `Branch that the local version of the repo is checked out to.`) + cmd.Flags().StringVar(&updateReq.Branch, "branch", updateReq.Branch, `Branch that the local version of the repo is checked out to. Wire name: 'branch'.`) // TODO: complex arg: sparse_checkout - cmd.Flags().StringVar(&updateReq.Tag, "tag", updateReq.Tag, `Tag that the local version of the repo is checked out to.`) + cmd.Flags().StringVar(&updateReq.Tag, "tag", updateReq.Tag, `Tag that the local version of the repo is checked out to. Wire name: 'tag'.`) cmd.Use = "update REPO_ID" cmd.Short = `Update a repo.` diff --git a/cmd/workspace/resource-quotas/resource-quotas.go b/cmd/workspace/resource-quotas/resource-quotas.go index da2979d9fd..9559393bb6 100755 --- a/cmd/workspace/resource-quotas/resource-quotas.go +++ b/cmd/workspace/resource-quotas/resource-quotas.go @@ -124,8 +124,8 @@ func newListQuotas() *cobra.Command { var listQuotasReq catalog.ListQuotasRequest - cmd.Flags().IntVar(&listQuotasReq.MaxResults, "max-results", listQuotasReq.MaxResults, `The number of quotas to return.`) - cmd.Flags().StringVar(&listQuotasReq.PageToken, "page-token", listQuotasReq.PageToken, `Opaque token for the next page of results.`) + cmd.Flags().IntVar(&listQuotasReq.MaxResults, "max-results", listQuotasReq.MaxResults, `The number of quotas to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listQuotasReq.PageToken, "page-token", listQuotasReq.PageToken, `Opaque token for the next page of results. Wire name: 'page_token'.`) cmd.Use = "list-quotas" cmd.Short = `List all resource quotas under a metastore.` diff --git a/cmd/workspace/restrict-workspace-admins/restrict-workspace-admins.go b/cmd/workspace/restrict-workspace-admins/restrict-workspace-admins.go index 77cb09a28e..5b60553d87 100755 --- a/cmd/workspace/restrict-workspace-admins/restrict-workspace-admins.go +++ b/cmd/workspace/restrict-workspace-admins/restrict-workspace-admins.go @@ -63,7 +63,7 @@ func newDelete() *cobra.Command { var deleteReq settings.DeleteRestrictWorkspaceAdminsSettingRequest - cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "delete" cmd.Short = `Delete the restrict workspace admins setting.` @@ -120,7 +120,7 @@ func newGet() *cobra.Command { var getReq settings.GetRestrictWorkspaceAdminsSettingRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the restrict workspace admins setting.` diff --git a/cmd/workspace/schemas/schemas.go b/cmd/workspace/schemas/schemas.go index cbb8dd9668..62d8e4f1a0 100755 --- a/cmd/workspace/schemas/schemas.go +++ b/cmd/workspace/schemas/schemas.go @@ -65,9 +65,9 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `User-provided free-form text description.`) + cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `User-provided free-form text description. Wire name: 'comment'.`) // TODO: map via StringToStringVar: properties - cmd.Flags().StringVar(&createReq.StorageRoot, "storage-root", createReq.StorageRoot, `Storage root URL for managed tables within schema.`) + cmd.Flags().StringVar(&createReq.StorageRoot, "storage-root", createReq.StorageRoot, `Storage root URL for managed tables within schema. Wire name: 'storage_root'.`) cmd.Use = "create NAME CATALOG_NAME" cmd.Short = `Create a schema.` @@ -152,7 +152,7 @@ func newDelete() *cobra.Command { var deleteReq catalog.DeleteSchemaRequest - cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the schema is not empty.`) + cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the schema is not empty. Wire name: 'force'.`) cmd.Use = "delete FULL_NAME" cmd.Short = `Delete a schema.` @@ -211,7 +211,7 @@ func newGet() *cobra.Command { var getReq catalog.GetSchemaRequest - cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include schemas in the response for which the principal can only access selective metadata for.`) + cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include schemas in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) cmd.Use = "get FULL_NAME" cmd.Short = `Get a schema.` @@ -271,9 +271,9 @@ func newList() *cobra.Command { var listReq catalog.ListSchemasRequest - cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include schemas in the response for which the principal can only access selective metadata for.`) - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of schemas to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include schemas in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of schemas to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list CATALOG_NAME" cmd.Short = `List schemas.` @@ -343,10 +343,10 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `User-provided free-form text description.`) - cmd.Flags().Var(&updateReq.EnablePredictiveOptimization, "enable-predictive-optimization", `Whether predictive optimization should be enabled for this object and objects under it. Supported values: [DISABLE, ENABLE, INHERIT]`) - cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the schema.`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of schema.`) + cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `User-provided free-form text description. Wire name: 'comment'.`) + cmd.Flags().Var(&updateReq.EnablePredictiveOptimization, "enable-predictive-optimization", `Whether predictive optimization should be enabled for this object and objects under it. Supported values: [DISABLE, ENABLE, INHERIT]. Wire name: 'enable_predictive_optimization'.`) + cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the schema. Wire name: 'new_name'.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of schema. Wire name: 'owner'.`) // TODO: map via StringToStringVar: properties cmd.Use = "update FULL_NAME" diff --git a/cmd/workspace/secrets/secrets.go b/cmd/workspace/secrets/secrets.go index 2425ecfb8f..0c3539edc7 100755 --- a/cmd/workspace/secrets/secrets.go +++ b/cmd/workspace/secrets/secrets.go @@ -78,8 +78,8 @@ func newCreateScope() *cobra.Command { cmd.Flags().Var(&createScopeJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: backend_azure_keyvault - cmd.Flags().StringVar(&createScopeReq.InitialManagePrincipal, "initial-manage-principal", createScopeReq.InitialManagePrincipal, `The principal that is initially granted MANAGE permission to the created scope.`) - cmd.Flags().Var(&createScopeReq.ScopeBackendType, "scope-backend-type", `The backend type the scope will be created with. Supported values: [AZURE_KEYVAULT, DATABRICKS]`) + cmd.Flags().StringVar(&createScopeReq.InitialManagePrincipal, "initial-manage-principal", createScopeReq.InitialManagePrincipal, `The principal that is initially granted MANAGE permission to the created scope. Wire name: 'initial_manage_principal'.`) + cmd.Flags().Var(&createScopeReq.ScopeBackendType, "scope-backend-type", `The backend type the scope will be created with. Supported values: [AZURE_KEYVAULT, DATABRICKS]. Wire name: 'scope_backend_type'.`) cmd.Use = "create-scope SCOPE" cmd.Short = `Create a new secret scope.` diff --git a/cmd/workspace/service-principal-secrets-proxy/service-principal-secrets-proxy.go b/cmd/workspace/service-principal-secrets-proxy/service-principal-secrets-proxy.go index edbda27e40..0d9b7a73dc 100755 --- a/cmd/workspace/service-principal-secrets-proxy/service-principal-secrets-proxy.go +++ b/cmd/workspace/service-principal-secrets-proxy/service-principal-secrets-proxy.go @@ -71,7 +71,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Lifetime, "lifetime", createReq.Lifetime, `The lifetime of the secret in seconds.`) + cmd.Flags().StringVar(&createReq.Lifetime, "lifetime", createReq.Lifetime, `The lifetime of the secret in seconds. Wire name: 'lifetime'.`) cmd.Use = "create SERVICE_PRINCIPAL_ID" cmd.Short = `Create service principal secret.` @@ -199,8 +199,8 @@ func newList() *cobra.Command { var listReq oauth2.ListServicePrincipalSecretsRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `An opaque page token which was the next_page_token in the response of the previous request to list the secrets for this service principal.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `An opaque page token which was the next_page_token in the response of the previous request to list the secrets for this service principal. Wire name: 'page_token'.`) cmd.Use = "list SERVICE_PRINCIPAL_ID" cmd.Short = `List service principal secrets.` diff --git a/cmd/workspace/service-principals-v2/service-principals-v2.go b/cmd/workspace/service-principals-v2/service-principals-v2.go index a0377fd5a6..98b9ff2611 100755 --- a/cmd/workspace/service-principals-v2/service-principals-v2.go +++ b/cmd/workspace/service-principals-v2/service-principals-v2.go @@ -65,13 +65,13 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&createReq.Active, "active", createReq.Active, `If this user is active.`) - cmd.Flags().StringVar(&createReq.ApplicationId, "application-id", createReq.ApplicationId, `UUID relating to the service principal.`) - cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `String that represents a concatenation of given and family names.`) + cmd.Flags().BoolVar(&createReq.Active, "active", createReq.Active, `If this user is active. Wire name: 'active'.`) + cmd.Flags().StringVar(&createReq.ApplicationId, "application-id", createReq.ApplicationId, `UUID relating to the service principal. Wire name: 'applicationId'.`) + cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `String that represents a concatenation of given and family names. Wire name: 'displayName'.`) // TODO: array: entitlements - cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, ``) + cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, `Wire name: 'externalId'.`) // TODO: array: groups - cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks service principal ID.`) + cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks service principal ID. Wire name: 'id'.`) // TODO: array: roles // TODO: array: schemas @@ -252,13 +252,13 @@ func newList() *cobra.Command { var listReq iam.ListServicePrincipalsRequest - cmd.Flags().StringVar(&listReq.Attributes, "attributes", listReq.Attributes, `Comma-separated list of attributes to return in response.`) - cmd.Flags().Int64Var(&listReq.Count, "count", listReq.Count, `Desired number of results per page.`) - cmd.Flags().StringVar(&listReq.ExcludedAttributes, "excluded-attributes", listReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response.`) - cmd.Flags().StringVar(&listReq.Filter, "filter", listReq.Filter, `Query by which the results have to be filtered.`) - cmd.Flags().StringVar(&listReq.SortBy, "sort-by", listReq.SortBy, `Attribute to sort the results.`) - cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]`) - cmd.Flags().Int64Var(&listReq.StartIndex, "start-index", listReq.StartIndex, `Specifies the index of the first result.`) + cmd.Flags().StringVar(&listReq.Attributes, "attributes", listReq.Attributes, `Comma-separated list of attributes to return in response. Wire name: 'attributes'.`) + cmd.Flags().Int64Var(&listReq.Count, "count", listReq.Count, `Desired number of results per page. Wire name: 'count'.`) + cmd.Flags().StringVar(&listReq.ExcludedAttributes, "excluded-attributes", listReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response. Wire name: 'excludedAttributes'.`) + cmd.Flags().StringVar(&listReq.Filter, "filter", listReq.Filter, `Query by which the results have to be filtered. Wire name: 'filter'.`) + cmd.Flags().StringVar(&listReq.SortBy, "sort-by", listReq.SortBy, `Attribute to sort the results. Wire name: 'sortBy'.`) + cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]. Wire name: 'sortOrder'.`) + cmd.Flags().Int64Var(&listReq.StartIndex, "start-index", listReq.StartIndex, `Specifies the index of the first result. Wire name: 'startIndex'.`) cmd.Use = "list" cmd.Short = `List service principals.` @@ -386,11 +386,11 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&updateReq.Active, "active", updateReq.Active, `If this user is active.`) - cmd.Flags().StringVar(&updateReq.ApplicationId, "application-id", updateReq.ApplicationId, `UUID relating to the service principal.`) - cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `String that represents a concatenation of given and family names.`) + cmd.Flags().BoolVar(&updateReq.Active, "active", updateReq.Active, `If this user is active. Wire name: 'active'.`) + cmd.Flags().StringVar(&updateReq.ApplicationId, "application-id", updateReq.ApplicationId, `UUID relating to the service principal. Wire name: 'applicationId'.`) + cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `String that represents a concatenation of given and family names. Wire name: 'displayName'.`) // TODO: array: entitlements - cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, ``) + cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, `Wire name: 'externalId'.`) // TODO: array: groups // TODO: array: roles // TODO: array: schemas diff --git a/cmd/workspace/serving-endpoints/serving-endpoints.go b/cmd/workspace/serving-endpoints/serving-endpoints.go index deeec41747..5bec997482 100755 --- a/cmd/workspace/serving-endpoints/serving-endpoints.go +++ b/cmd/workspace/serving-endpoints/serving-endpoints.go @@ -157,12 +157,12 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: ai_gateway - cmd.Flags().StringVar(&createReq.BudgetPolicyId, "budget-policy-id", createReq.BudgetPolicyId, `The budget policy to be applied to the serving endpoint.`) + cmd.Flags().StringVar(&createReq.BudgetPolicyId, "budget-policy-id", createReq.BudgetPolicyId, `The budget policy to be applied to the serving endpoint. Wire name: 'budget_policy_id'.`) // TODO: complex arg: config - cmd.Flags().StringVar(&createReq.Description, "description", createReq.Description, ``) + cmd.Flags().StringVar(&createReq.Description, "description", createReq.Description, `Wire name: 'description'.`) // TODO: complex arg: email_notifications // TODO: array: rate_limits - cmd.Flags().BoolVar(&createReq.RouteOptimized, "route-optimized", createReq.RouteOptimized, `Enable route optimization for the serving endpoint.`) + cmd.Flags().BoolVar(&createReq.RouteOptimized, "route-optimized", createReq.RouteOptimized, `Enable route optimization for the serving endpoint. Wire name: 'route_optimized'.`) // TODO: array: tags cmd.Use = "create NAME" @@ -265,7 +265,7 @@ func newCreateProvisionedThroughputEndpoint() *cobra.Command { cmd.Flags().Var(&createProvisionedThroughputEndpointJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: complex arg: ai_gateway - cmd.Flags().StringVar(&createProvisionedThroughputEndpointReq.BudgetPolicyId, "budget-policy-id", createProvisionedThroughputEndpointReq.BudgetPolicyId, `The budget policy associated with the endpoint.`) + cmd.Flags().StringVar(&createProvisionedThroughputEndpointReq.BudgetPolicyId, "budget-policy-id", createProvisionedThroughputEndpointReq.BudgetPolicyId, `The budget policy associated with the endpoint. Wire name: 'budget_policy_id'.`) // TODO: complex arg: email_notifications // TODO: array: tags @@ -680,9 +680,9 @@ func newHttpRequest() *cobra.Command { var httpRequestReq serving.ExternalFunctionRequest - cmd.Flags().StringVar(&httpRequestReq.Headers, "headers", httpRequestReq.Headers, `Additional headers for the request.`) - cmd.Flags().StringVar(&httpRequestReq.Json, "json", httpRequestReq.Json, `The JSON payload to send in the request body.`) - cmd.Flags().StringVar(&httpRequestReq.Params, "params", httpRequestReq.Params, `Query parameters for the request.`) + cmd.Flags().StringVar(&httpRequestReq.Headers, "headers", httpRequestReq.Headers, `Additional headers for the request. Wire name: 'headers'.`) + cmd.Flags().StringVar(&httpRequestReq.Json, "json", httpRequestReq.Json, `The JSON payload to send in the request body. Wire name: 'json'.`) + cmd.Flags().StringVar(&httpRequestReq.Params, "params", httpRequestReq.Params, `Query parameters for the request. Wire name: 'params'.`) cmd.Use = "http-request CONNECTION_NAME METHOD PATH" cmd.Short = `Make external services call using the credentials stored in UC Connection.` @@ -1082,20 +1082,20 @@ func newQuery() *cobra.Command { cmd.Flags().Var(&queryJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&queryReq.ClientRequestId, "client-request-id", queryReq.ClientRequestId, `Optional user-provided request identifier that will be recorded in the inference table and the usage tracking table.`) + cmd.Flags().StringVar(&queryReq.ClientRequestId, "client-request-id", queryReq.ClientRequestId, `Optional user-provided request identifier that will be recorded in the inference table and the usage tracking table. Wire name: 'client_request_id'.`) // TODO: array: dataframe_records // TODO: complex arg: dataframe_split // TODO: map via StringToStringVar: extra_params // TODO: any: input // TODO: any: inputs // TODO: array: instances - cmd.Flags().IntVar(&queryReq.MaxTokens, "max-tokens", queryReq.MaxTokens, `The max tokens field used ONLY for __completions__ and __chat external & foundation model__ serving endpoints.`) + cmd.Flags().IntVar(&queryReq.MaxTokens, "max-tokens", queryReq.MaxTokens, `The max tokens field used ONLY for __completions__ and __chat external & foundation model__ serving endpoints. Wire name: 'max_tokens'.`) // TODO: array: messages - cmd.Flags().IntVar(&queryReq.N, "n", queryReq.N, `The n (number of candidates) field used ONLY for __completions__ and __chat external & foundation model__ serving endpoints.`) + cmd.Flags().IntVar(&queryReq.N, "n", queryReq.N, `The n (number of candidates) field used ONLY for __completions__ and __chat external & foundation model__ serving endpoints. Wire name: 'n'.`) // TODO: any: prompt // TODO: array: stop - cmd.Flags().BoolVar(&queryReq.Stream, "stream", queryReq.Stream, `The stream field used ONLY for __completions__ and __chat external & foundation model__ serving endpoints.`) - cmd.Flags().Float64Var(&queryReq.Temperature, "temperature", queryReq.Temperature, `The temperature field used ONLY for __completions__ and __chat external & foundation model__ serving endpoints.`) + cmd.Flags().BoolVar(&queryReq.Stream, "stream", queryReq.Stream, `The stream field used ONLY for __completions__ and __chat external & foundation model__ serving endpoints. Wire name: 'stream'.`) + cmd.Flags().Float64Var(&queryReq.Temperature, "temperature", queryReq.Temperature, `The temperature field used ONLY for __completions__ and __chat external & foundation model__ serving endpoints. Wire name: 'temperature'.`) // TODO: map via StringToStringVar: usage_context cmd.Use = "query NAME" diff --git a/cmd/workspace/shares/shares.go b/cmd/workspace/shares/shares.go index c5f48ca19d..66fec597ca 100755 --- a/cmd/workspace/shares/shares.go +++ b/cmd/workspace/shares/shares.go @@ -67,8 +67,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `User-provided free-form text description.`) - cmd.Flags().StringVar(&createReq.StorageRoot, "storage-root", createReq.StorageRoot, `Storage root URL for the share.`) + cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `User-provided free-form text description. Wire name: 'comment'.`) + cmd.Flags().StringVar(&createReq.StorageRoot, "storage-root", createReq.StorageRoot, `Storage root URL for the share. Wire name: 'storage_root'.`) cmd.Use = "create NAME" cmd.Short = `Create a share.` @@ -206,7 +206,7 @@ func newGet() *cobra.Command { var getReq sharing.GetShareRequest - cmd.Flags().BoolVar(&getReq.IncludeSharedData, "include-shared-data", getReq.IncludeSharedData, `Query for data to include in the share.`) + cmd.Flags().BoolVar(&getReq.IncludeSharedData, "include-shared-data", getReq.IncludeSharedData, `Query for data to include in the share. Wire name: 'include_shared_data'.`) cmd.Use = "get NAME" cmd.Short = `Get a share.` @@ -265,8 +265,8 @@ func newListShares() *cobra.Command { var listSharesReq sharing.SharesListRequest - cmd.Flags().IntVar(&listSharesReq.MaxResults, "max-results", listSharesReq.MaxResults, `Maximum number of shares to return.`) - cmd.Flags().StringVar(&listSharesReq.PageToken, "page-token", listSharesReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().IntVar(&listSharesReq.MaxResults, "max-results", listSharesReq.MaxResults, `Maximum number of shares to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listSharesReq.PageToken, "page-token", listSharesReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list-shares" cmd.Short = `List shares.` @@ -319,8 +319,8 @@ func newSharePermissions() *cobra.Command { var sharePermissionsReq sharing.SharePermissionsRequest - cmd.Flags().IntVar(&sharePermissionsReq.MaxResults, "max-results", sharePermissionsReq.MaxResults, `Maximum number of permissions to return.`) - cmd.Flags().StringVar(&sharePermissionsReq.PageToken, "page-token", sharePermissionsReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().IntVar(&sharePermissionsReq.MaxResults, "max-results", sharePermissionsReq.MaxResults, `Maximum number of permissions to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&sharePermissionsReq.PageToken, "page-token", sharePermissionsReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "share-permissions NAME" cmd.Short = `Get permissions.` @@ -382,10 +382,10 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `User-provided free-form text description.`) - cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the share.`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of share.`) - cmd.Flags().StringVar(&updateReq.StorageRoot, "storage-root", updateReq.StorageRoot, `Storage root URL for the share.`) + cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `User-provided free-form text description. Wire name: 'comment'.`) + cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the share. Wire name: 'new_name'.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of share. Wire name: 'owner'.`) + cmd.Flags().StringVar(&updateReq.StorageRoot, "storage-root", updateReq.StorageRoot, `Storage root URL for the share. Wire name: 'storage_root'.`) // TODO: array: updates cmd.Use = "update NAME" @@ -476,7 +476,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Flags().Var(&updatePermissionsJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: changes - cmd.Flags().BoolVar(&updatePermissionsReq.OmitPermissionsList, "omit-permissions-list", updatePermissionsReq.OmitPermissionsList, `Optional.`) + cmd.Flags().BoolVar(&updatePermissionsReq.OmitPermissionsList, "omit-permissions-list", updatePermissionsReq.OmitPermissionsList, `Optional. Wire name: 'omit_permissions_list'.`) cmd.Use = "update-permissions NAME" cmd.Short = `Update permissions.` diff --git a/cmd/workspace/sql-results-download/sql-results-download.go b/cmd/workspace/sql-results-download/sql-results-download.go index e96170fbea..07a52ddad4 100755 --- a/cmd/workspace/sql-results-download/sql-results-download.go +++ b/cmd/workspace/sql-results-download/sql-results-download.go @@ -54,7 +54,7 @@ func newDelete() *cobra.Command { var deleteReq settings.DeleteSqlResultsDownloadRequest - cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&deleteReq.Etag, "etag", deleteReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "delete" cmd.Short = `Delete the SQL Results Download setting.` @@ -107,7 +107,7 @@ func newGet() *cobra.Command { var getReq settings.GetSqlResultsDownloadRequest - cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning.`) + cmd.Flags().StringVar(&getReq.Etag, "etag", getReq.Etag, `etag used for versioning. Wire name: 'etag'.`) cmd.Use = "get" cmd.Short = `Get the SQL Results Download setting.` diff --git a/cmd/workspace/storage-credentials/storage-credentials.go b/cmd/workspace/storage-credentials/storage-credentials.go index 5630aba1ef..b126474c35 100755 --- a/cmd/workspace/storage-credentials/storage-credentials.go +++ b/cmd/workspace/storage-credentials/storage-credentials.go @@ -78,10 +78,10 @@ func newCreate() *cobra.Command { // TODO: complex arg: azure_managed_identity // TODO: complex arg: azure_service_principal // TODO: complex arg: cloudflare_api_token - cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `Comment associated with the credential.`) + cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `Comment associated with the credential. Wire name: 'comment'.`) // TODO: complex arg: databricks_gcp_service_account - cmd.Flags().BoolVar(&createReq.ReadOnly, "read-only", createReq.ReadOnly, `Whether the credential is usable only for read operations.`) - cmd.Flags().BoolVar(&createReq.SkipValidation, "skip-validation", createReq.SkipValidation, `Supplying true to this argument skips validation of the created credential.`) + cmd.Flags().BoolVar(&createReq.ReadOnly, "read-only", createReq.ReadOnly, `Whether the credential is usable only for read operations. Wire name: 'read_only'.`) + cmd.Flags().BoolVar(&createReq.SkipValidation, "skip-validation", createReq.SkipValidation, `Supplying true to this argument skips validation of the created credential. Wire name: 'skip_validation'.`) cmd.Use = "create NAME" cmd.Short = `Create a storage credential.` @@ -164,7 +164,7 @@ func newDelete() *cobra.Command { var deleteReq catalog.DeleteStorageCredentialRequest - cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force an update even if there are dependent external locations or external tables (when purpose is **STORAGE**) or dependent services (when purpose is **SERVICE**).`) + cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force an update even if there are dependent external locations or external tables (when purpose is **STORAGE**) or dependent services (when purpose is **SERVICE**). Wire name: 'force'.`) cmd.Use = "delete NAME" cmd.Short = `Delete a credential.` @@ -281,9 +281,9 @@ func newList() *cobra.Command { var listReq catalog.ListStorageCredentialsRequest - cmd.Flags().BoolVar(&listReq.IncludeUnbound, "include-unbound", listReq.IncludeUnbound, `Whether to include credentials not bound to the workspace.`) - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of storage credentials to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().BoolVar(&listReq.IncludeUnbound, "include-unbound", listReq.IncludeUnbound, `Whether to include credentials not bound to the workspace. Wire name: 'include_unbound'.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of storage credentials to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list" cmd.Short = `List credentials.` @@ -352,14 +352,14 @@ func newUpdate() *cobra.Command { // TODO: complex arg: azure_managed_identity // TODO: complex arg: azure_service_principal // TODO: complex arg: cloudflare_api_token - cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `Comment associated with the credential.`) + cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `Comment associated with the credential. Wire name: 'comment'.`) // TODO: complex arg: databricks_gcp_service_account - cmd.Flags().BoolVar(&updateReq.Force, "force", updateReq.Force, `Force update even if there are dependent external locations or external tables.`) - cmd.Flags().Var(&updateReq.IsolationMode, "isolation-mode", `Whether the current securable is accessible from all workspaces or a specific set of workspaces. Supported values: [ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN]`) - cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the storage credential.`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of credential.`) - cmd.Flags().BoolVar(&updateReq.ReadOnly, "read-only", updateReq.ReadOnly, `Whether the credential is usable only for read operations.`) - cmd.Flags().BoolVar(&updateReq.SkipValidation, "skip-validation", updateReq.SkipValidation, `Supplying true to this argument skips validation of the updated credential.`) + cmd.Flags().BoolVar(&updateReq.Force, "force", updateReq.Force, `Force update even if there are dependent external locations or external tables. Wire name: 'force'.`) + cmd.Flags().Var(&updateReq.IsolationMode, "isolation-mode", `Whether the current securable is accessible from all workspaces or a specific set of workspaces. Supported values: [ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN]. Wire name: 'isolation_mode'.`) + cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the storage credential. Wire name: 'new_name'.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of credential. Wire name: 'owner'.`) + cmd.Flags().BoolVar(&updateReq.ReadOnly, "read-only", updateReq.ReadOnly, `Whether the credential is usable only for read operations. Wire name: 'read_only'.`) + cmd.Flags().BoolVar(&updateReq.SkipValidation, "skip-validation", updateReq.SkipValidation, `Supplying true to this argument skips validation of the updated credential. Wire name: 'skip_validation'.`) cmd.Use = "update NAME" cmd.Short = `Update a credential.` @@ -440,10 +440,10 @@ func newValidate() *cobra.Command { // TODO: complex arg: azure_service_principal // TODO: complex arg: cloudflare_api_token // TODO: complex arg: databricks_gcp_service_account - cmd.Flags().StringVar(&validateReq.ExternalLocationName, "external-location-name", validateReq.ExternalLocationName, `The name of an existing external location to validate.`) - cmd.Flags().BoolVar(&validateReq.ReadOnly, "read-only", validateReq.ReadOnly, `Whether the storage credential is only usable for read operations.`) - cmd.Flags().StringVar(&validateReq.StorageCredentialName, "storage-credential-name", validateReq.StorageCredentialName, `Required.`) - cmd.Flags().StringVar(&validateReq.Url, "url", validateReq.Url, `The external location url to validate.`) + cmd.Flags().StringVar(&validateReq.ExternalLocationName, "external-location-name", validateReq.ExternalLocationName, `The name of an existing external location to validate. Wire name: 'external_location_name'.`) + cmd.Flags().BoolVar(&validateReq.ReadOnly, "read-only", validateReq.ReadOnly, `Whether the storage credential is only usable for read operations. Wire name: 'read_only'.`) + cmd.Flags().StringVar(&validateReq.StorageCredentialName, "storage-credential-name", validateReq.StorageCredentialName, `Required. Wire name: 'storage_credential_name'.`) + cmd.Flags().StringVar(&validateReq.Url, "url", validateReq.Url, `The external location url to validate. Wire name: 'url'.`) cmd.Use = "validate" cmd.Short = `Validate a storage credential.` diff --git a/cmd/workspace/system-schemas/system-schemas.go b/cmd/workspace/system-schemas/system-schemas.go index 8cff5356e2..8718d91a7a 100755 --- a/cmd/workspace/system-schemas/system-schemas.go +++ b/cmd/workspace/system-schemas/system-schemas.go @@ -118,7 +118,7 @@ func newEnable() *cobra.Command { cmd.Flags().Var(&enableJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&enableReq.CatalogName, "catalog-name", enableReq.CatalogName, `the catalog for which the system schema is to enabled in.`) + cmd.Flags().StringVar(&enableReq.CatalogName, "catalog-name", enableReq.CatalogName, `the catalog for which the system schema is to enabled in. Wire name: 'catalog_name'.`) cmd.Use = "enable METASTORE_ID SCHEMA_NAME" cmd.Short = `Enable a system schema.` @@ -191,8 +191,8 @@ func newList() *cobra.Command { var listReq catalog.ListSystemSchemasRequest - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of schemas to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of schemas to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "list METASTORE_ID" cmd.Short = `List system schemas.` diff --git a/cmd/workspace/tables/tables.go b/cmd/workspace/tables/tables.go index 57375d4f1f..12c6d1415e 100755 --- a/cmd/workspace/tables/tables.go +++ b/cmd/workspace/tables/tables.go @@ -368,9 +368,9 @@ func newGet() *cobra.Command { var getReq catalog.GetTableRequest - cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include tables in the response for which the principal can only access selective metadata for.`) - cmd.Flags().BoolVar(&getReq.IncludeDeltaMetadata, "include-delta-metadata", getReq.IncludeDeltaMetadata, `Whether delta metadata should be included in the response.`) - cmd.Flags().BoolVar(&getReq.IncludeManifestCapabilities, "include-manifest-capabilities", getReq.IncludeManifestCapabilities, `Whether to include a manifest containing table capabilities in the response.`) + cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include tables in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) + cmd.Flags().BoolVar(&getReq.IncludeDeltaMetadata, "include-delta-metadata", getReq.IncludeDeltaMetadata, `Whether delta metadata should be included in the response. Wire name: 'include_delta_metadata'.`) + cmd.Flags().BoolVar(&getReq.IncludeManifestCapabilities, "include-manifest-capabilities", getReq.IncludeManifestCapabilities, `Whether to include a manifest containing table capabilities in the response. Wire name: 'include_manifest_capabilities'.`) cmd.Use = "get FULL_NAME" cmd.Short = `Get a table.` @@ -434,13 +434,13 @@ func newList() *cobra.Command { var listReq catalog.ListTablesRequest - cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include tables in the response for which the principal can only access selective metadata for.`) - cmd.Flags().BoolVar(&listReq.IncludeManifestCapabilities, "include-manifest-capabilities", listReq.IncludeManifestCapabilities, `Whether to include a manifest containing table capabilities in the response.`) - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of tables to return.`) - cmd.Flags().BoolVar(&listReq.OmitColumns, "omit-columns", listReq.OmitColumns, `Whether to omit the columns of the table from the response or not.`) - cmd.Flags().BoolVar(&listReq.OmitProperties, "omit-properties", listReq.OmitProperties, `Whether to omit the properties of the table from the response or not.`) - cmd.Flags().BoolVar(&listReq.OmitUsername, "omit-username", listReq.OmitUsername, `Whether to omit the username of the table (e.g.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque token to send for the next page of results (pagination).`) + cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include tables in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) + cmd.Flags().BoolVar(&listReq.IncludeManifestCapabilities, "include-manifest-capabilities", listReq.IncludeManifestCapabilities, `Whether to include a manifest containing table capabilities in the response. Wire name: 'include_manifest_capabilities'.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of tables to return. Wire name: 'max_results'.`) + cmd.Flags().BoolVar(&listReq.OmitColumns, "omit-columns", listReq.OmitColumns, `Whether to omit the columns of the table from the response or not. Wire name: 'omit_columns'.`) + cmd.Flags().BoolVar(&listReq.OmitProperties, "omit-properties", listReq.OmitProperties, `Whether to omit the properties of the table from the response or not. Wire name: 'omit_properties'.`) + cmd.Flags().BoolVar(&listReq.OmitUsername, "omit-username", listReq.OmitUsername, `Whether to omit the username of the table (e.g. Wire name: 'omit_username'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque token to send for the next page of results (pagination). Wire name: 'page_token'.`) cmd.Use = "list CATALOG_NAME SCHEMA_NAME" cmd.Short = `List tables.` @@ -510,11 +510,11 @@ func newListSummaries() *cobra.Command { var listSummariesReq catalog.ListSummariesRequest - cmd.Flags().BoolVar(&listSummariesReq.IncludeManifestCapabilities, "include-manifest-capabilities", listSummariesReq.IncludeManifestCapabilities, `Whether to include a manifest containing table capabilities in the response.`) - cmd.Flags().IntVar(&listSummariesReq.MaxResults, "max-results", listSummariesReq.MaxResults, `Maximum number of summaries for tables to return.`) - cmd.Flags().StringVar(&listSummariesReq.PageToken, "page-token", listSummariesReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) - cmd.Flags().StringVar(&listSummariesReq.SchemaNamePattern, "schema-name-pattern", listSummariesReq.SchemaNamePattern, `A sql LIKE pattern (% and _) for schema names.`) - cmd.Flags().StringVar(&listSummariesReq.TableNamePattern, "table-name-pattern", listSummariesReq.TableNamePattern, `A sql LIKE pattern (% and _) for table names.`) + cmd.Flags().BoolVar(&listSummariesReq.IncludeManifestCapabilities, "include-manifest-capabilities", listSummariesReq.IncludeManifestCapabilities, `Whether to include a manifest containing table capabilities in the response. Wire name: 'include_manifest_capabilities'.`) + cmd.Flags().IntVar(&listSummariesReq.MaxResults, "max-results", listSummariesReq.MaxResults, `Maximum number of summaries for tables to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listSummariesReq.PageToken, "page-token", listSummariesReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) + cmd.Flags().StringVar(&listSummariesReq.SchemaNamePattern, "schema-name-pattern", listSummariesReq.SchemaNamePattern, `A sql LIKE pattern (% and _) for schema names. Wire name: 'schema_name_pattern'.`) + cmd.Flags().StringVar(&listSummariesReq.TableNamePattern, "table-name-pattern", listSummariesReq.TableNamePattern, `A sql LIKE pattern (% and _) for table names. Wire name: 'table_name_pattern'.`) cmd.Use = "list-summaries CATALOG_NAME" cmd.Short = `List table summaries.` @@ -587,7 +587,7 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of table.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of table. Wire name: 'owner'.`) cmd.Use = "update FULL_NAME" cmd.Short = `Update a table owner.` diff --git a/cmd/workspace/tag-policies/tag-policies.go b/cmd/workspace/tag-policies/tag-policies.go index ae78bf28a8..27ddac3ae8 100755 --- a/cmd/workspace/tag-policies/tag-policies.go +++ b/cmd/workspace/tag-policies/tag-policies.go @@ -66,7 +66,7 @@ func newCreateTagPolicy() *cobra.Command { cmd.Flags().Var(&createTagPolicyJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createTagPolicyReq.TagPolicy.Description, "description", createTagPolicyReq.TagPolicy.Description, ``) + cmd.Flags().StringVar(&createTagPolicyReq.TagPolicy.Description, "description", createTagPolicyReq.TagPolicy.Description, `Wire name: 'description'.`) // TODO: array: values cmd.Use = "create-tag-policy TAG_KEY" @@ -250,8 +250,8 @@ func newListTagPolicies() *cobra.Command { var listTagPoliciesReq tags.ListTagPoliciesRequest - cmd.Flags().IntVar(&listTagPoliciesReq.PageSize, "page-size", listTagPoliciesReq.PageSize, `The maximum number of results to return in this request.`) - cmd.Flags().StringVar(&listTagPoliciesReq.PageToken, "page-token", listTagPoliciesReq.PageToken, `An optional page token received from a previous list tag policies call.`) + cmd.Flags().IntVar(&listTagPoliciesReq.PageSize, "page-size", listTagPoliciesReq.PageSize, `The maximum number of results to return in this request. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listTagPoliciesReq.PageToken, "page-token", listTagPoliciesReq.PageToken, `An optional page token received from a previous list tag policies call. Wire name: 'page_token'.`) cmd.Use = "list-tag-policies" cmd.Short = `List tag policies.` @@ -305,7 +305,7 @@ func newUpdateTagPolicy() *cobra.Command { cmd.Flags().Var(&updateTagPolicyJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateTagPolicyReq.TagPolicy.Description, "description", updateTagPolicyReq.TagPolicy.Description, ``) + cmd.Flags().StringVar(&updateTagPolicyReq.TagPolicy.Description, "description", updateTagPolicyReq.TagPolicy.Description, `Wire name: 'description'.`) // TODO: array: values cmd.Use = "update-tag-policy TAG_KEY UPDATE_MASK" diff --git a/cmd/workspace/temporary-path-credentials/temporary-path-credentials.go b/cmd/workspace/temporary-path-credentials/temporary-path-credentials.go index ba4e0bf99a..3a84954b4f 100755 --- a/cmd/workspace/temporary-path-credentials/temporary-path-credentials.go +++ b/cmd/workspace/temporary-path-credentials/temporary-path-credentials.go @@ -82,7 +82,7 @@ func newGenerateTemporaryPathCredentials() *cobra.Command { cmd.Flags().Var(&generateTemporaryPathCredentialsJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&generateTemporaryPathCredentialsReq.DryRun, "dry-run", generateTemporaryPathCredentialsReq.DryRun, `Optional.`) + cmd.Flags().BoolVar(&generateTemporaryPathCredentialsReq.DryRun, "dry-run", generateTemporaryPathCredentialsReq.DryRun, `Optional. Wire name: 'dry_run'.`) cmd.Use = "generate-temporary-path-credentials URL OPERATION" cmd.Short = `Generate a temporary path credential.` diff --git a/cmd/workspace/temporary-table-credentials/temporary-table-credentials.go b/cmd/workspace/temporary-table-credentials/temporary-table-credentials.go index 1bb949fd3a..61dbc60af7 100755 --- a/cmd/workspace/temporary-table-credentials/temporary-table-credentials.go +++ b/cmd/workspace/temporary-table-credentials/temporary-table-credentials.go @@ -71,8 +71,8 @@ func newGenerateTemporaryTableCredentials() *cobra.Command { cmd.Flags().Var(&generateTemporaryTableCredentialsJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().Var(&generateTemporaryTableCredentialsReq.Operation, "operation", `The operation performed against the table data, either READ or READ_WRITE. Supported values: [READ, READ_WRITE]`) - cmd.Flags().StringVar(&generateTemporaryTableCredentialsReq.TableId, "table-id", generateTemporaryTableCredentialsReq.TableId, `UUID of the table to read or write.`) + cmd.Flags().Var(&generateTemporaryTableCredentialsReq.Operation, "operation", `The operation performed against the table data, either READ or READ_WRITE. Supported values: [READ, READ_WRITE]. Wire name: 'operation'.`) + cmd.Flags().StringVar(&generateTemporaryTableCredentialsReq.TableId, "table-id", generateTemporaryTableCredentialsReq.TableId, `UUID of the table to read or write. Wire name: 'table_id'.`) cmd.Use = "generate-temporary-table-credentials" cmd.Short = `Generate a temporary table credential.` diff --git a/cmd/workspace/token-management/token-management.go b/cmd/workspace/token-management/token-management.go index 438769a936..65afabf0f6 100755 --- a/cmd/workspace/token-management/token-management.go +++ b/cmd/workspace/token-management/token-management.go @@ -66,8 +66,8 @@ func newCreateOboToken() *cobra.Command { cmd.Flags().Var(&createOboTokenJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createOboTokenReq.Comment, "comment", createOboTokenReq.Comment, `Comment that describes the purpose of the token.`) - cmd.Flags().Int64Var(&createOboTokenReq.LifetimeSeconds, "lifetime-seconds", createOboTokenReq.LifetimeSeconds, `The number of seconds before the token expires.`) + cmd.Flags().StringVar(&createOboTokenReq.Comment, "comment", createOboTokenReq.Comment, `Comment that describes the purpose of the token. Wire name: 'comment'.`) + cmd.Flags().Int64Var(&createOboTokenReq.LifetimeSeconds, "lifetime-seconds", createOboTokenReq.LifetimeSeconds, `The number of seconds before the token expires. Wire name: 'lifetime_seconds'.`) cmd.Use = "create-obo-token APPLICATION_ID" cmd.Short = `Create on-behalf token.` @@ -383,8 +383,8 @@ func newList() *cobra.Command { var listReq settings.ListTokenManagementRequest - cmd.Flags().Int64Var(&listReq.CreatedById, "created-by-id", listReq.CreatedById, `User ID of the user that created the token.`) - cmd.Flags().StringVar(&listReq.CreatedByUsername, "created-by-username", listReq.CreatedByUsername, `Username of the user that created the token.`) + cmd.Flags().Int64Var(&listReq.CreatedById, "created-by-id", listReq.CreatedById, `User ID of the user that created the token. Wire name: 'created_by_id'.`) + cmd.Flags().StringVar(&listReq.CreatedByUsername, "created-by-username", listReq.CreatedByUsername, `Username of the user that created the token. Wire name: 'created_by_username'.`) cmd.Use = "list" cmd.Short = `List all tokens.` diff --git a/cmd/workspace/tokens/tokens.go b/cmd/workspace/tokens/tokens.go index 52d3390efb..e0348a95a3 100755 --- a/cmd/workspace/tokens/tokens.go +++ b/cmd/workspace/tokens/tokens.go @@ -60,8 +60,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `Optional description to attach to the token.`) - cmd.Flags().Int64Var(&createReq.LifetimeSeconds, "lifetime-seconds", createReq.LifetimeSeconds, `The lifetime of the token, in seconds.`) + cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `Optional description to attach to the token. Wire name: 'comment'.`) + cmd.Flags().Int64Var(&createReq.LifetimeSeconds, "lifetime-seconds", createReq.LifetimeSeconds, `The lifetime of the token, in seconds. Wire name: 'lifetime_seconds'.`) cmd.Use = "create" cmd.Short = `Create a user token.` diff --git a/cmd/workspace/users-v2/users-v2.go b/cmd/workspace/users-v2/users-v2.go index c7484f091c..2e5c6eb179 100755 --- a/cmd/workspace/users-v2/users-v2.go +++ b/cmd/workspace/users-v2/users-v2.go @@ -74,17 +74,17 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&createReq.Active, "active", createReq.Active, `If this user is active.`) - cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `String that represents a concatenation of given and family names.`) + cmd.Flags().BoolVar(&createReq.Active, "active", createReq.Active, `If this user is active. Wire name: 'active'.`) + cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `String that represents a concatenation of given and family names. Wire name: 'displayName'.`) // TODO: array: emails // TODO: array: entitlements - cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, `External ID is not currently supported.`) + cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, `External ID is not currently supported. Wire name: 'externalId'.`) // TODO: array: groups - cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks user ID.`) + cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks user ID. Wire name: 'id'.`) // TODO: complex arg: name // TODO: array: roles // TODO: array: schemas - cmd.Flags().StringVar(&createReq.UserName, "user-name", createReq.UserName, `Email address of the Databricks user.`) + cmd.Flags().StringVar(&createReq.UserName, "user-name", createReq.UserName, `Email address of the Databricks user. Wire name: 'userName'.`) cmd.Use = "create" cmd.Short = `Create a new user.` @@ -208,13 +208,13 @@ func newGet() *cobra.Command { var getReq iam.GetUserRequest - cmd.Flags().StringVar(&getReq.Attributes, "attributes", getReq.Attributes, `Comma-separated list of attributes to return in response.`) - cmd.Flags().IntVar(&getReq.Count, "count", getReq.Count, `Desired number of results per page.`) - cmd.Flags().StringVar(&getReq.ExcludedAttributes, "excluded-attributes", getReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response.`) - cmd.Flags().StringVar(&getReq.Filter, "filter", getReq.Filter, `Query by which the results have to be filtered.`) - cmd.Flags().StringVar(&getReq.SortBy, "sort-by", getReq.SortBy, `Attribute to sort the results.`) - cmd.Flags().Var(&getReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]`) - cmd.Flags().IntVar(&getReq.StartIndex, "start-index", getReq.StartIndex, `Specifies the index of the first result.`) + cmd.Flags().StringVar(&getReq.Attributes, "attributes", getReq.Attributes, `Comma-separated list of attributes to return in response. Wire name: 'attributes'.`) + cmd.Flags().IntVar(&getReq.Count, "count", getReq.Count, `Desired number of results per page. Wire name: 'count'.`) + cmd.Flags().StringVar(&getReq.ExcludedAttributes, "excluded-attributes", getReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response. Wire name: 'excludedAttributes'.`) + cmd.Flags().StringVar(&getReq.Filter, "filter", getReq.Filter, `Query by which the results have to be filtered. Wire name: 'filter'.`) + cmd.Flags().StringVar(&getReq.SortBy, "sort-by", getReq.SortBy, `Attribute to sort the results. Wire name: 'sortBy'.`) + cmd.Flags().Var(&getReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]. Wire name: 'sortOrder'.`) + cmd.Flags().IntVar(&getReq.StartIndex, "start-index", getReq.StartIndex, `Specifies the index of the first result. Wire name: 'startIndex'.`) cmd.Use = "get ID" cmd.Short = `Get user details.` @@ -365,13 +365,13 @@ func newList() *cobra.Command { var listReq iam.ListUsersRequest - cmd.Flags().StringVar(&listReq.Attributes, "attributes", listReq.Attributes, `Comma-separated list of attributes to return in response.`) - cmd.Flags().Int64Var(&listReq.Count, "count", listReq.Count, `Desired number of results per page.`) - cmd.Flags().StringVar(&listReq.ExcludedAttributes, "excluded-attributes", listReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response.`) - cmd.Flags().StringVar(&listReq.Filter, "filter", listReq.Filter, `Query by which the results have to be filtered.`) - cmd.Flags().StringVar(&listReq.SortBy, "sort-by", listReq.SortBy, `Attribute to sort the results.`) - cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]`) - cmd.Flags().Int64Var(&listReq.StartIndex, "start-index", listReq.StartIndex, `Specifies the index of the first result.`) + cmd.Flags().StringVar(&listReq.Attributes, "attributes", listReq.Attributes, `Comma-separated list of attributes to return in response. Wire name: 'attributes'.`) + cmd.Flags().Int64Var(&listReq.Count, "count", listReq.Count, `Desired number of results per page. Wire name: 'count'.`) + cmd.Flags().StringVar(&listReq.ExcludedAttributes, "excluded-attributes", listReq.ExcludedAttributes, `Comma-separated list of attributes to exclude in response. Wire name: 'excludedAttributes'.`) + cmd.Flags().StringVar(&listReq.Filter, "filter", listReq.Filter, `Query by which the results have to be filtered. Wire name: 'filter'.`) + cmd.Flags().StringVar(&listReq.SortBy, "sort-by", listReq.SortBy, `Attribute to sort the results. Wire name: 'sortBy'.`) + cmd.Flags().Var(&listReq.SortOrder, "sort-order", `The order to sort the results. Supported values: [ascending, descending]. Wire name: 'sortOrder'.`) + cmd.Flags().Int64Var(&listReq.StartIndex, "start-index", listReq.StartIndex, `Specifies the index of the first result. Wire name: 'startIndex'.`) cmd.Use = "list" cmd.Short = `List users.` @@ -570,16 +570,16 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&updateReq.Active, "active", updateReq.Active, `If this user is active.`) - cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `String that represents a concatenation of given and family names.`) + cmd.Flags().BoolVar(&updateReq.Active, "active", updateReq.Active, `If this user is active. Wire name: 'active'.`) + cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `String that represents a concatenation of given and family names. Wire name: 'displayName'.`) // TODO: array: emails // TODO: array: entitlements - cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, `External ID is not currently supported.`) + cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, `External ID is not currently supported. Wire name: 'externalId'.`) // TODO: array: groups // TODO: complex arg: name // TODO: array: roles // TODO: array: schemas - cmd.Flags().StringVar(&updateReq.UserName, "user-name", updateReq.UserName, `Email address of the Databricks user.`) + cmd.Flags().StringVar(&updateReq.UserName, "user-name", updateReq.UserName, `Email address of the Databricks user. Wire name: 'userName'.`) cmd.Use = "update ID" cmd.Short = `Replace a user.` diff --git a/cmd/workspace/vector-search-endpoints/vector-search-endpoints.go b/cmd/workspace/vector-search-endpoints/vector-search-endpoints.go index ef5d757e60..ce0db4fc6e 100755 --- a/cmd/workspace/vector-search-endpoints/vector-search-endpoints.go +++ b/cmd/workspace/vector-search-endpoints/vector-search-endpoints.go @@ -69,7 +69,7 @@ func newCreateEndpoint() *cobra.Command { cmd.Flags().Var(&createEndpointJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createEndpointReq.BudgetPolicyId, "budget-policy-id", createEndpointReq.BudgetPolicyId, `The budget policy id to be applied.`) + cmd.Flags().StringVar(&createEndpointReq.BudgetPolicyId, "budget-policy-id", createEndpointReq.BudgetPolicyId, `The budget policy id to be applied. Wire name: 'budget_policy_id'.`) cmd.Use = "create-endpoint NAME ENDPOINT_TYPE" cmd.Short = `Create an endpoint.` @@ -288,7 +288,7 @@ func newListEndpoints() *cobra.Command { var listEndpointsReq vectorsearch.ListEndpointsRequest - cmd.Flags().StringVar(&listEndpointsReq.PageToken, "page-token", listEndpointsReq.PageToken, `Token for pagination.`) + cmd.Flags().StringVar(&listEndpointsReq.PageToken, "page-token", listEndpointsReq.PageToken, `Token for pagination. Wire name: 'page_token'.`) cmd.Use = "list-endpoints" cmd.Short = `List all endpoints.` diff --git a/cmd/workspace/vector-search-indexes/vector-search-indexes.go b/cmd/workspace/vector-search-indexes/vector-search-indexes.go index 1fe0bcd6d1..025569c225 100755 --- a/cmd/workspace/vector-search-indexes/vector-search-indexes.go +++ b/cmd/workspace/vector-search-indexes/vector-search-indexes.go @@ -299,7 +299,7 @@ func newGetIndex() *cobra.Command { var getIndexReq vectorsearch.GetIndexRequest - cmd.Flags().BoolVar(&getIndexReq.EnsureRerankerCompatible, "ensure-reranker-compatible", getIndexReq.EnsureRerankerCompatible, `If true, the URL returned for the index is guaranteed to be compatible with the reranker.`) + cmd.Flags().BoolVar(&getIndexReq.EnsureRerankerCompatible, "ensure-reranker-compatible", getIndexReq.EnsureRerankerCompatible, `If true, the URL returned for the index is guaranteed to be compatible with the reranker. Wire name: 'ensure_reranker_compatible'.`) cmd.Use = "get-index INDEX_NAME" cmd.Short = `Get an index.` @@ -355,7 +355,7 @@ func newListIndexes() *cobra.Command { var listIndexesReq vectorsearch.ListIndexesRequest - cmd.Flags().StringVar(&listIndexesReq.PageToken, "page-token", listIndexesReq.PageToken, `Token for pagination.`) + cmd.Flags().StringVar(&listIndexesReq.PageToken, "page-token", listIndexesReq.PageToken, `Token for pagination. Wire name: 'page_token'.`) cmd.Use = "list-indexes ENDPOINT_NAME" cmd.Short = `List indexes.` @@ -414,13 +414,13 @@ func newQueryIndex() *cobra.Command { cmd.Flags().Var(&queryIndexJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: columns_to_rerank - cmd.Flags().StringVar(&queryIndexReq.FiltersJson, "filters-json", queryIndexReq.FiltersJson, `JSON string representing query filters.`) - cmd.Flags().IntVar(&queryIndexReq.NumResults, "num-results", queryIndexReq.NumResults, `Number of results to return.`) - cmd.Flags().StringVar(&queryIndexReq.QueryText, "query-text", queryIndexReq.QueryText, `Query text.`) - cmd.Flags().StringVar(&queryIndexReq.QueryType, "query-type", queryIndexReq.QueryType, `The query type to use.`) + cmd.Flags().StringVar(&queryIndexReq.FiltersJson, "filters-json", queryIndexReq.FiltersJson, `JSON string representing query filters. Wire name: 'filters_json'.`) + cmd.Flags().IntVar(&queryIndexReq.NumResults, "num-results", queryIndexReq.NumResults, `Number of results to return. Wire name: 'num_results'.`) + cmd.Flags().StringVar(&queryIndexReq.QueryText, "query-text", queryIndexReq.QueryText, `Query text. Wire name: 'query_text'.`) + cmd.Flags().StringVar(&queryIndexReq.QueryType, "query-type", queryIndexReq.QueryType, `The query type to use. Wire name: 'query_type'.`) // TODO: array: query_vector // TODO: complex arg: reranker - cmd.Flags().Float64Var(&queryIndexReq.ScoreThreshold, "score-threshold", queryIndexReq.ScoreThreshold, `Threshold for the approximate nearest neighbor search.`) + cmd.Flags().Float64Var(&queryIndexReq.ScoreThreshold, "score-threshold", queryIndexReq.ScoreThreshold, `Threshold for the approximate nearest neighbor search. Wire name: 'score_threshold'.`) cmd.Use = "query-index INDEX_NAME" cmd.Short = `Query an index.` @@ -495,8 +495,8 @@ func newQueryNextPage() *cobra.Command { cmd.Flags().Var(&queryNextPageJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&queryNextPageReq.EndpointName, "endpoint-name", queryNextPageReq.EndpointName, `Name of the endpoint.`) - cmd.Flags().StringVar(&queryNextPageReq.PageToken, "page-token", queryNextPageReq.PageToken, `Page token returned from previous QueryVectorIndex or QueryVectorIndexNextPage API.`) + cmd.Flags().StringVar(&queryNextPageReq.EndpointName, "endpoint-name", queryNextPageReq.EndpointName, `Name of the endpoint. Wire name: 'endpoint_name'.`) + cmd.Flags().StringVar(&queryNextPageReq.PageToken, "page-token", queryNextPageReq.PageToken, `Page token returned from previous QueryVectorIndex or QueryVectorIndexNextPage API. Wire name: 'page_token'.`) cmd.Use = "query-next-page INDEX_NAME" cmd.Short = `Query next page.` @@ -570,8 +570,8 @@ func newScanIndex() *cobra.Command { cmd.Flags().Var(&scanIndexJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&scanIndexReq.LastPrimaryKey, "last-primary-key", scanIndexReq.LastPrimaryKey, `Primary key of the last entry returned in the previous scan.`) - cmd.Flags().IntVar(&scanIndexReq.NumResults, "num-results", scanIndexReq.NumResults, `Number of results to return.`) + cmd.Flags().StringVar(&scanIndexReq.LastPrimaryKey, "last-primary-key", scanIndexReq.LastPrimaryKey, `Primary key of the last entry returned in the previous scan. Wire name: 'last_primary_key'.`) + cmd.Flags().IntVar(&scanIndexReq.NumResults, "num-results", scanIndexReq.NumResults, `Number of results to return. Wire name: 'num_results'.`) cmd.Use = "scan-index INDEX_NAME" cmd.Short = `Scan an index.` diff --git a/cmd/workspace/volumes/volumes.go b/cmd/workspace/volumes/volumes.go index 7e14adabd0..64cd8e40d9 100755 --- a/cmd/workspace/volumes/volumes.go +++ b/cmd/workspace/volumes/volumes.go @@ -68,8 +68,8 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `The comment attached to the volume.`) - cmd.Flags().StringVar(&createReq.StorageLocation, "storage-location", createReq.StorageLocation, `The storage location on the cloud.`) + cmd.Flags().StringVar(&createReq.Comment, "comment", createReq.Comment, `The comment attached to the volume. Wire name: 'comment'.`) + cmd.Flags().StringVar(&createReq.StorageLocation, "storage-location", createReq.StorageLocation, `The storage location on the cloud. Wire name: 'storage_location'.`) cmd.Use = "create CATALOG_NAME SCHEMA_NAME NAME VOLUME_TYPE" cmd.Short = `Create a Volume.` @@ -259,9 +259,9 @@ func newList() *cobra.Command { var listReq catalog.ListVolumesRequest - cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include volumes in the response for which the principal can only access selective metadata for.`) - cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of volumes to return (page length).`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque token returned by a previous request.`) + cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include volumes in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) + cmd.Flags().IntVar(&listReq.MaxResults, "max-results", listReq.MaxResults, `Maximum number of volumes to return (page length). Wire name: 'max_results'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Opaque token returned by a previous request. Wire name: 'page_token'.`) cmd.Use = "list CATALOG_NAME SCHEMA_NAME" cmd.Short = `List Volumes.` @@ -333,7 +333,7 @@ func newRead() *cobra.Command { var readReq catalog.ReadVolumeRequest - cmd.Flags().BoolVar(&readReq.IncludeBrowse, "include-browse", readReq.IncludeBrowse, `Whether to include volumes in the response for which the principal can only access selective metadata for.`) + cmd.Flags().BoolVar(&readReq.IncludeBrowse, "include-browse", readReq.IncludeBrowse, `Whether to include volumes in the response for which the principal can only access selective metadata for. Wire name: 'include_browse'.`) cmd.Use = "read NAME" cmd.Short = `Get a Volume.` @@ -411,9 +411,9 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `The comment attached to the volume.`) - cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the volume.`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `The identifier of the user who owns the volume.`) + cmd.Flags().StringVar(&updateReq.Comment, "comment", updateReq.Comment, `The comment attached to the volume. Wire name: 'comment'.`) + cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the volume. Wire name: 'new_name'.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `The identifier of the user who owns the volume. Wire name: 'owner'.`) cmd.Use = "update NAME" cmd.Short = `Update a Volume.` diff --git a/cmd/workspace/warehouses/warehouses.go b/cmd/workspace/warehouses/warehouses.go index 966b886444..b0575cb117 100755 --- a/cmd/workspace/warehouses/warehouses.go +++ b/cmd/workspace/warehouses/warehouses.go @@ -78,19 +78,19 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().IntVar(&createReq.AutoStopMins, "auto-stop-mins", createReq.AutoStopMins, `The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries) before it is automatically stopped.`) + cmd.Flags().IntVar(&createReq.AutoStopMins, "auto-stop-mins", createReq.AutoStopMins, `The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries) before it is automatically stopped. Wire name: 'auto_stop_mins'.`) // TODO: complex arg: channel - cmd.Flags().StringVar(&createReq.ClusterSize, "cluster-size", createReq.ClusterSize, `Size of the clusters allocated for this warehouse.`) - cmd.Flags().StringVar(&createReq.CreatorName, "creator-name", createReq.CreatorName, `warehouse creator name.`) - cmd.Flags().BoolVar(&createReq.EnablePhoton, "enable-photon", createReq.EnablePhoton, `Configures whether the warehouse should use Photon optimized clusters.`) - cmd.Flags().BoolVar(&createReq.EnableServerlessCompute, "enable-serverless-compute", createReq.EnableServerlessCompute, `Configures whether the warehouse should use serverless compute.`) - cmd.Flags().StringVar(&createReq.InstanceProfileArn, "instance-profile-arn", createReq.InstanceProfileArn, `Deprecated.`) - cmd.Flags().IntVar(&createReq.MaxNumClusters, "max-num-clusters", createReq.MaxNumClusters, `Maximum number of clusters that the autoscaler will create to handle concurrent queries.`) - cmd.Flags().IntVar(&createReq.MinNumClusters, "min-num-clusters", createReq.MinNumClusters, `Minimum number of available clusters that will be maintained for this SQL warehouse.`) - cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `Logical name for the cluster.`) - cmd.Flags().Var(&createReq.SpotInstancePolicy, "spot-instance-policy", `Configurations whether the endpoint should use spot instances. Supported values: [COST_OPTIMIZED, POLICY_UNSPECIFIED, RELIABILITY_OPTIMIZED]`) + cmd.Flags().StringVar(&createReq.ClusterSize, "cluster-size", createReq.ClusterSize, `Size of the clusters allocated for this warehouse. Wire name: 'cluster_size'.`) + cmd.Flags().StringVar(&createReq.CreatorName, "creator-name", createReq.CreatorName, `warehouse creator name. Wire name: 'creator_name'.`) + cmd.Flags().BoolVar(&createReq.EnablePhoton, "enable-photon", createReq.EnablePhoton, `Configures whether the warehouse should use Photon optimized clusters. Wire name: 'enable_photon'.`) + cmd.Flags().BoolVar(&createReq.EnableServerlessCompute, "enable-serverless-compute", createReq.EnableServerlessCompute, `Configures whether the warehouse should use serverless compute. Wire name: 'enable_serverless_compute'.`) + cmd.Flags().StringVar(&createReq.InstanceProfileArn, "instance-profile-arn", createReq.InstanceProfileArn, `Deprecated. Wire name: 'instance_profile_arn'.`) + cmd.Flags().IntVar(&createReq.MaxNumClusters, "max-num-clusters", createReq.MaxNumClusters, `Maximum number of clusters that the autoscaler will create to handle concurrent queries. Wire name: 'max_num_clusters'.`) + cmd.Flags().IntVar(&createReq.MinNumClusters, "min-num-clusters", createReq.MinNumClusters, `Minimum number of available clusters that will be maintained for this SQL warehouse. Wire name: 'min_num_clusters'.`) + cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `Logical name for the cluster. Wire name: 'name'.`) + cmd.Flags().Var(&createReq.SpotInstancePolicy, "spot-instance-policy", `Configurations whether the endpoint should use spot instances. Supported values: [COST_OPTIMIZED, POLICY_UNSPECIFIED, RELIABILITY_OPTIMIZED]. Wire name: 'spot_instance_policy'.`) // TODO: complex arg: tags - cmd.Flags().Var(&createReq.WarehouseType, "warehouse-type", `Warehouse type: PRO or CLASSIC. Supported values: [CLASSIC, PRO, TYPE_UNSPECIFIED]`) + cmd.Flags().Var(&createReq.WarehouseType, "warehouse-type", `Warehouse type: PRO or CLASSIC. Supported values: [CLASSIC, PRO, TYPE_UNSPECIFIED]. Wire name: 'warehouse_type'.`) cmd.Use = "create" cmd.Short = `Create a warehouse.` @@ -252,19 +252,19 @@ func newEdit() *cobra.Command { cmd.Flags().Var(&editJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().IntVar(&editReq.AutoStopMins, "auto-stop-mins", editReq.AutoStopMins, `The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries) before it is automatically stopped.`) + cmd.Flags().IntVar(&editReq.AutoStopMins, "auto-stop-mins", editReq.AutoStopMins, `The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries) before it is automatically stopped. Wire name: 'auto_stop_mins'.`) // TODO: complex arg: channel - cmd.Flags().StringVar(&editReq.ClusterSize, "cluster-size", editReq.ClusterSize, `Size of the clusters allocated for this warehouse.`) - cmd.Flags().StringVar(&editReq.CreatorName, "creator-name", editReq.CreatorName, `warehouse creator name.`) - cmd.Flags().BoolVar(&editReq.EnablePhoton, "enable-photon", editReq.EnablePhoton, `Configures whether the warehouse should use Photon optimized clusters.`) - cmd.Flags().BoolVar(&editReq.EnableServerlessCompute, "enable-serverless-compute", editReq.EnableServerlessCompute, `Configures whether the warehouse should use serverless compute.`) - cmd.Flags().StringVar(&editReq.InstanceProfileArn, "instance-profile-arn", editReq.InstanceProfileArn, `Deprecated.`) - cmd.Flags().IntVar(&editReq.MaxNumClusters, "max-num-clusters", editReq.MaxNumClusters, `Maximum number of clusters that the autoscaler will create to handle concurrent queries.`) - cmd.Flags().IntVar(&editReq.MinNumClusters, "min-num-clusters", editReq.MinNumClusters, `Minimum number of available clusters that will be maintained for this SQL warehouse.`) - cmd.Flags().StringVar(&editReq.Name, "name", editReq.Name, `Logical name for the cluster.`) - cmd.Flags().Var(&editReq.SpotInstancePolicy, "spot-instance-policy", `Configurations whether the endpoint should use spot instances. Supported values: [COST_OPTIMIZED, POLICY_UNSPECIFIED, RELIABILITY_OPTIMIZED]`) + cmd.Flags().StringVar(&editReq.ClusterSize, "cluster-size", editReq.ClusterSize, `Size of the clusters allocated for this warehouse. Wire name: 'cluster_size'.`) + cmd.Flags().StringVar(&editReq.CreatorName, "creator-name", editReq.CreatorName, `warehouse creator name. Wire name: 'creator_name'.`) + cmd.Flags().BoolVar(&editReq.EnablePhoton, "enable-photon", editReq.EnablePhoton, `Configures whether the warehouse should use Photon optimized clusters. Wire name: 'enable_photon'.`) + cmd.Flags().BoolVar(&editReq.EnableServerlessCompute, "enable-serverless-compute", editReq.EnableServerlessCompute, `Configures whether the warehouse should use serverless compute. Wire name: 'enable_serverless_compute'.`) + cmd.Flags().StringVar(&editReq.InstanceProfileArn, "instance-profile-arn", editReq.InstanceProfileArn, `Deprecated. Wire name: 'instance_profile_arn'.`) + cmd.Flags().IntVar(&editReq.MaxNumClusters, "max-num-clusters", editReq.MaxNumClusters, `Maximum number of clusters that the autoscaler will create to handle concurrent queries. Wire name: 'max_num_clusters'.`) + cmd.Flags().IntVar(&editReq.MinNumClusters, "min-num-clusters", editReq.MinNumClusters, `Minimum number of available clusters that will be maintained for this SQL warehouse. Wire name: 'min_num_clusters'.`) + cmd.Flags().StringVar(&editReq.Name, "name", editReq.Name, `Logical name for the cluster. Wire name: 'name'.`) + cmd.Flags().Var(&editReq.SpotInstancePolicy, "spot-instance-policy", `Configurations whether the endpoint should use spot instances. Supported values: [COST_OPTIMIZED, POLICY_UNSPECIFIED, RELIABILITY_OPTIMIZED]. Wire name: 'spot_instance_policy'.`) // TODO: complex arg: tags - cmd.Flags().Var(&editReq.WarehouseType, "warehouse-type", `Warehouse type: PRO or CLASSIC. Supported values: [CLASSIC, PRO, TYPE_UNSPECIFIED]`) + cmd.Flags().Var(&editReq.WarehouseType, "warehouse-type", `Warehouse type: PRO or CLASSIC. Supported values: [CLASSIC, PRO, TYPE_UNSPECIFIED]. Wire name: 'warehouse_type'.`) cmd.Use = "edit ID" cmd.Short = `Update a warehouse.` @@ -613,9 +613,9 @@ func newList() *cobra.Command { var listReq sql.ListWarehousesRequest - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `The max number of warehouses to return.`) - cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A page token, received from a previous ListWarehouses call.`) - cmd.Flags().IntVar(&listReq.RunAsUserId, "run-as-user-id", listReq.RunAsUserId, `Service Principal which will be used to fetch the list of endpoints.`) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `The max number of warehouses to return. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `A page token, received from a previous ListWarehouses call. Wire name: 'page_token'.`) + cmd.Flags().IntVar(&listReq.RunAsUserId, "run-as-user-id", listReq.RunAsUserId, `Service Principal which will be used to fetch the list of endpoints. Wire name: 'run_as_user_id'.`) cmd.Use = "list" cmd.Short = `List warehouses.` @@ -758,12 +758,12 @@ func newSetWorkspaceWarehouseConfig() *cobra.Command { // TODO: complex arg: channel // TODO: complex arg: config_param // TODO: array: data_access_config - cmd.Flags().BoolVar(&setWorkspaceWarehouseConfigReq.EnableServerlessCompute, "enable-serverless-compute", setWorkspaceWarehouseConfigReq.EnableServerlessCompute, `Enable Serverless compute for SQL warehouses.`) + cmd.Flags().BoolVar(&setWorkspaceWarehouseConfigReq.EnableServerlessCompute, "enable-serverless-compute", setWorkspaceWarehouseConfigReq.EnableServerlessCompute, `Enable Serverless compute for SQL warehouses. Wire name: 'enable_serverless_compute'.`) // TODO: array: enabled_warehouse_types // TODO: complex arg: global_param - cmd.Flags().StringVar(&setWorkspaceWarehouseConfigReq.GoogleServiceAccount, "google-service-account", setWorkspaceWarehouseConfigReq.GoogleServiceAccount, `GCP only: Google Service Account used to pass to cluster to access Google Cloud Storage.`) - cmd.Flags().StringVar(&setWorkspaceWarehouseConfigReq.InstanceProfileArn, "instance-profile-arn", setWorkspaceWarehouseConfigReq.InstanceProfileArn, `AWS Only: The instance profile used to pass an IAM role to the SQL warehouses.`) - cmd.Flags().Var(&setWorkspaceWarehouseConfigReq.SecurityPolicy, "security-policy", `Security policy for warehouses. Supported values: [DATA_ACCESS_CONTROL, NONE, PASSTHROUGH]`) + cmd.Flags().StringVar(&setWorkspaceWarehouseConfigReq.GoogleServiceAccount, "google-service-account", setWorkspaceWarehouseConfigReq.GoogleServiceAccount, `GCP only: Google Service Account used to pass to cluster to access Google Cloud Storage. Wire name: 'google_service_account'.`) + cmd.Flags().StringVar(&setWorkspaceWarehouseConfigReq.InstanceProfileArn, "instance-profile-arn", setWorkspaceWarehouseConfigReq.InstanceProfileArn, `AWS Only: The instance profile used to pass an IAM role to the SQL warehouses. Wire name: 'instance_profile_arn'.`) + cmd.Flags().Var(&setWorkspaceWarehouseConfigReq.SecurityPolicy, "security-policy", `Security policy for warehouses. Supported values: [DATA_ACCESS_CONTROL, NONE, PASSTHROUGH]. Wire name: 'security_policy'.`) // TODO: complex arg: sql_configuration_parameters cmd.Use = "set-workspace-warehouse-config" diff --git a/cmd/workspace/workspace-bindings/workspace-bindings.go b/cmd/workspace/workspace-bindings/workspace-bindings.go index 194be2961e..23c8a54274 100755 --- a/cmd/workspace/workspace-bindings/workspace-bindings.go +++ b/cmd/workspace/workspace-bindings/workspace-bindings.go @@ -130,8 +130,8 @@ func newGetBindings() *cobra.Command { var getBindingsReq catalog.GetBindingsRequest - cmd.Flags().IntVar(&getBindingsReq.MaxResults, "max-results", getBindingsReq.MaxResults, `Maximum number of workspace bindings to return.`) - cmd.Flags().StringVar(&getBindingsReq.PageToken, "page-token", getBindingsReq.PageToken, `Opaque pagination token to go to next page based on previous query.`) + cmd.Flags().IntVar(&getBindingsReq.MaxResults, "max-results", getBindingsReq.MaxResults, `Maximum number of workspace bindings to return. Wire name: 'max_results'.`) + cmd.Flags().StringVar(&getBindingsReq.PageToken, "page-token", getBindingsReq.PageToken, `Opaque pagination token to go to next page based on previous query. Wire name: 'page_token'.`) cmd.Use = "get-bindings SECURABLE_TYPE SECURABLE_NAME" cmd.Short = `Get securable workspace bindings.` diff --git a/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go b/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go index 956c208e7e..4957bc80b2 100755 --- a/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go +++ b/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go @@ -58,7 +58,7 @@ func newGetWorkspaceAccessDetailLocal() *cobra.Command { var getWorkspaceAccessDetailLocalReq iamv2.GetWorkspaceAccessDetailLocalRequest - cmd.Flags().Var(&getWorkspaceAccessDetailLocalReq.View, "view", `Controls what fields are returned. Supported values: [BASIC, FULL]`) + cmd.Flags().Var(&getWorkspaceAccessDetailLocalReq.View, "view", `Controls what fields are returned. Supported values: [BASIC, FULL]. Wire name: 'view'.`) cmd.Use = "get-workspace-access-detail-local PRINCIPAL_ID" cmd.Short = `Get workspace access details for a principal.` diff --git a/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go b/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go index 42890935cd..60856751bb 100755 --- a/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go +++ b/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go @@ -109,8 +109,8 @@ func newListWorkspaceSettingsMetadata() *cobra.Command { var listWorkspaceSettingsMetadataReq settingsv2.ListWorkspaceSettingsMetadataRequest - cmd.Flags().IntVar(&listWorkspaceSettingsMetadataReq.PageSize, "page-size", listWorkspaceSettingsMetadataReq.PageSize, `The maximum number of settings to return.`) - cmd.Flags().StringVar(&listWorkspaceSettingsMetadataReq.PageToken, "page-token", listWorkspaceSettingsMetadataReq.PageToken, `A page token, received from a previous ListWorkspaceSettingsMetadataRequest call.`) + cmd.Flags().IntVar(&listWorkspaceSettingsMetadataReq.PageSize, "page-size", listWorkspaceSettingsMetadataReq.PageSize, `The maximum number of settings to return. Wire name: 'page_size'.`) + cmd.Flags().StringVar(&listWorkspaceSettingsMetadataReq.PageToken, "page-token", listWorkspaceSettingsMetadataReq.PageToken, `A page token, received from a previous ListWorkspaceSettingsMetadataRequest call. Wire name: 'page_token'.`) cmd.Use = "list-workspace-settings-metadata" cmd.Short = `List valid setting keys and their metadata.` @@ -179,7 +179,7 @@ func newPatchPublicWorkspaceSetting() *cobra.Command { // TODO: complex arg: effective_restrict_workspace_admins // TODO: complex arg: effective_string_val // TODO: complex arg: integer_val - cmd.Flags().StringVar(&patchPublicWorkspaceSettingReq.Setting.Name, "name", patchPublicWorkspaceSettingReq.Setting.Name, `Name of the setting.`) + cmd.Flags().StringVar(&patchPublicWorkspaceSettingReq.Setting.Name, "name", patchPublicWorkspaceSettingReq.Setting.Name, `Name of the setting. Wire name: 'name'.`) // TODO: complex arg: personal_compute // TODO: complex arg: restrict_workspace_admins // TODO: complex arg: string_val diff --git a/cmd/workspace/workspace/workspace.go b/cmd/workspace/workspace/workspace.go index 502b11fdb7..805c0a808b 100755 --- a/cmd/workspace/workspace/workspace.go +++ b/cmd/workspace/workspace/workspace.go @@ -70,7 +70,7 @@ func newDelete() *cobra.Command { cmd.Flags().Var(&deleteJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&deleteReq.Recursive, "recursive", deleteReq.Recursive, `The flag that specifies whether to delete the object recursively.`) + cmd.Flags().BoolVar(&deleteReq.Recursive, "recursive", deleteReq.Recursive, `The flag that specifies whether to delete the object recursively. Wire name: 'recursive'.`) cmd.Use = "delete PATH" cmd.Short = `Delete a workspace object.` @@ -180,7 +180,7 @@ func newExport() *cobra.Command { RAW, R_MARKDOWN, SOURCE, -]`) +]. Wire name: 'format'.`) cmd.Use = "export PATH" cmd.Short = `Export a workspace object.` @@ -435,7 +435,7 @@ func newImport() *cobra.Command { cmd.Flags().Var(&importJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&importReq.Content, "content", importReq.Content, `The base64-encoded content.`) + cmd.Flags().StringVar(&importReq.Content, "content", importReq.Content, `The base64-encoded content. Wire name: 'content'.`) cmd.Flags().Var(&importReq.Format, "format", `This specifies the format of the file to be imported. Supported values: [ AUTO, DBC, @@ -444,9 +444,9 @@ func newImport() *cobra.Command { RAW, R_MARKDOWN, SOURCE, -]`) - cmd.Flags().Var(&importReq.Language, "language", `The language of the object. Supported values: [PYTHON, R, SCALA, SQL]`) - cmd.Flags().BoolVar(&importReq.Overwrite, "overwrite", importReq.Overwrite, `The flag that specifies whether to overwrite existing object.`) +]. Wire name: 'format'.`) + cmd.Flags().Var(&importReq.Language, "language", `The language of the object. Supported values: [PYTHON, R, SCALA, SQL]. Wire name: 'language'.`) + cmd.Flags().BoolVar(&importReq.Overwrite, "overwrite", importReq.Overwrite, `The flag that specifies whether to overwrite existing object. Wire name: 'overwrite'.`) cmd.Use = "import PATH" cmd.Short = `Import a workspace object.` @@ -531,7 +531,7 @@ func newList() *cobra.Command { var listReq workspace.ListWorkspaceRequest - cmd.Flags().Int64Var(&listReq.NotebooksModifiedAfter, "notebooks-modified-after", listReq.NotebooksModifiedAfter, `UTC timestamp in milliseconds.`) + cmd.Flags().Int64Var(&listReq.NotebooksModifiedAfter, "notebooks-modified-after", listReq.NotebooksModifiedAfter, `UTC timestamp in milliseconds. Wire name: 'notebooks_modified_after'.`) cmd.Use = "list PATH" cmd.Short = `List contents.` diff --git a/experimental/python/databricks/bundles/jobs/_models/spark_jar_task.py b/experimental/python/databricks/bundles/jobs/_models/spark_jar_task.py index 40bbe92ba0..9b72738437 100644 --- a/experimental/python/databricks/bundles/jobs/_models/spark_jar_task.py +++ b/experimental/python/databricks/bundles/jobs/_models/spark_jar_task.py @@ -26,7 +26,9 @@ class SparkJarTask: jar_uri: VariableOrOptional[str] = None """ - [DEPRECATED] Deprecated since 04/2016. Provide a `jar` through the `libraries` field instead. For an example, see :method:jobs/create. + [DEPRECATED] Deprecated since 04/2016. For classic compute, provide a `jar` through the `libraries` field instead. For serverless compute, provide a `jar` though the `java_dependencies` field inside the `environments` list. + + See the examples of classic and serverless compute usage at the top of the page. """ parameters: VariableOrList[str] = field(default_factory=list) @@ -61,7 +63,9 @@ class SparkJarTaskDict(TypedDict, total=False): jar_uri: VariableOrOptional[str] """ - [DEPRECATED] Deprecated since 04/2016. Provide a `jar` through the `libraries` field instead. For an example, see :method:jobs/create. + [DEPRECATED] Deprecated since 04/2016. For classic compute, provide a `jar` through the `libraries` field instead. For serverless compute, provide a `jar` though the `java_dependencies` field inside the `environments` list. + + See the examples of classic and serverless compute usage at the top of the page. """ parameters: VariableOrList[str] diff --git a/experimental/python/databricks/bundles/pipelines/_models/ingestion_source_type.py b/experimental/python/databricks/bundles/pipelines/_models/ingestion_source_type.py index d9a90a022e..28d195416a 100644 --- a/experimental/python/databricks/bundles/pipelines/_models/ingestion_source_type.py +++ b/experimental/python/databricks/bundles/pipelines/_models/ingestion_source_type.py @@ -21,6 +21,13 @@ class IngestionSourceType(Enum): DYNAMICS365 = "DYNAMICS365" CONFLUENCE = "CONFLUENCE" META_MARKETING = "META_MARKETING" + GOOGLE_ADS = "GOOGLE_ADS" + TIKTOK_ADS = "TIKTOK_ADS" + SALESFORCE_MARKETING_CLOUD = "SALESFORCE_MARKETING_CLOUD" + HUBSPOT = "HUBSPOT" + WORKDAY_HCM = "WORKDAY_HCM" + GUIDEWIRE = "GUIDEWIRE" + ZENDESK = "ZENDESK" FOREIGN_CATALOG = "FOREIGN_CATALOG" @@ -44,6 +51,13 @@ class IngestionSourceType(Enum): "DYNAMICS365", "CONFLUENCE", "META_MARKETING", + "GOOGLE_ADS", + "TIKTOK_ADS", + "SALESFORCE_MARKETING_CLOUD", + "HUBSPOT", + "WORKDAY_HCM", + "GUIDEWIRE", + "ZENDESK", "FOREIGN_CATALOG", ] | IngestionSourceType diff --git a/go.mod b/go.mod index a0403f81f3..1bcda0a451 100644 --- a/go.mod +++ b/go.mod @@ -9,7 +9,7 @@ require ( github.com/BurntSushi/toml v1.5.0 // MIT github.com/Masterminds/semver/v3 v3.4.0 // MIT github.com/briandowns/spinner v1.23.1 // Apache 2.0 - github.com/databricks/databricks-sdk-go v0.89.0 // Apache 2.0 + github.com/databricks/databricks-sdk-go v0.90.0 // Apache 2.0 github.com/fatih/color v1.18.0 // MIT github.com/google/uuid v1.6.0 // BSD-3-Clause github.com/gorilla/mux v1.8.1 // BSD 3-Clause diff --git a/go.sum b/go.sum index db02c96f7b..f1b75ece67 100644 --- a/go.sum +++ b/go.sum @@ -29,8 +29,8 @@ github.com/cloudflare/circl v1.6.1/go.mod h1:uddAzsPgqdMAYatqJ0lsjX1oECcQLIlRpzZ github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g= github.com/cyphar/filepath-securejoin v0.4.1 h1:JyxxyPEaktOD+GAnqIqTf9A8tHyAG22rowi7HkoSU1s= github.com/cyphar/filepath-securejoin v0.4.1/go.mod h1:Sdj7gXlvMcPZsbhwhQ33GguGLDGQL7h7bg04C/+u9jI= -github.com/databricks/databricks-sdk-go v0.89.0 h1:x3bolIsX49Hov08O/BvH3QGcibD0VuiIOCBnTUGI8zs= -github.com/databricks/databricks-sdk-go v0.89.0/go.mod h1:hWoHnHbNLjPKiTm5K/7bcIv3J3Pkgo5x9pPzh8K3RVE= +github.com/databricks/databricks-sdk-go v0.90.0 h1:yS9kBd/4LEp3WzzFZ/th49A+WXn0bb6rEWLAYL4T6/8= +github.com/databricks/databricks-sdk-go v0.90.0/go.mod h1:hWoHnHbNLjPKiTm5K/7bcIv3J3Pkgo5x9pPzh8K3RVE= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= From 9877b6a99a9cc1239c463545ed278eabff47d7c2 Mon Sep 17 00:00:00 2001 From: JH <237805758+jh-db@users.noreply.github.com> Date: Fri, 24 Oct 2025 13:45:40 +0200 Subject: [PATCH 2/7] [WIP] support unified hosts --- cmd/auth/auth.go | 17 +++++ cmd/auth/login.go | 62 +++++++++++++++---- cmd/auth/login_test.go | 25 +++++--- cmd/auth/profiles.go | 2 +- cmd/auth/token.go | 6 +- go.mod | 2 + libs/auth/arguments.go | 14 +++-- libs/auth/error.go | 2 +- libs/databrickscfg/profile/file.go | 12 ++-- libs/databrickscfg/profile/file_test.go | 29 ++++++++- libs/databrickscfg/profile/profile.go | 12 ++-- .../profile/testdata/databrickscfg | 11 ++++ 12 files changed, 154 insertions(+), 40 deletions(-) diff --git a/cmd/auth/auth.go b/cmd/auth/auth.go index e00a1934a4..01bed59516 100644 --- a/cmd/auth/auth.go +++ b/cmd/auth/auth.go @@ -25,6 +25,7 @@ GCP: https://docs.gcp.databricks.com/dev-tools/auth/index.html`, var authArguments auth.AuthArguments cmd.PersistentFlags().StringVar(&authArguments.Host, "host", "", "Databricks Host") cmd.PersistentFlags().StringVar(&authArguments.AccountID, "account-id", "", "Databricks Account ID") + cmd.PersistentFlags().BoolVarP(&authArguments.IsUnifiedHost, "experimental-is-unified-host", "u", false, "Whether the host is a unified host") cmd.AddCommand(newEnvCommand()) cmd.AddCommand(newLoginCommand(&authArguments)) @@ -55,3 +56,19 @@ func promptForAccountID(ctx context.Context) (string, error) { prompt.AllowEdit = true return prompt.Run() } + +func promptForWorkspaceId(ctx context.Context) (string, error) { + if !cmdio.IsInTTY(ctx) { + return "", nil + } + + prompt := cmdio.Prompt(ctx) + prompt.Label = "Databricks workspace ID (optional - provide only if using this profile for workspace operations, leave empty for account operations)" + prompt.Default = "" + prompt.AllowEdit = true + result, err := prompt.Run() + if err != nil { + return "", err + } + return result, nil +} diff --git a/cmd/auth/login.go b/cmd/auth/login.go index 265f2c8ad0..fc06df319d 100644 --- a/cmd/auth/login.go +++ b/cmd/auth/login.go @@ -132,7 +132,7 @@ depends on the existing profiles you have set in your configuration file if err != nil { return err } - err = setHostAndAccountId(ctx, existingProfile, authArguments, args) + err = setHostAndAccountId(ctx, cmd, existingProfile, authArguments, args) if err != nil { return err } @@ -170,6 +170,12 @@ depends on the existing profiles you have set in your configuration file return err } + // Prompt for workspace_id if the host is unified + workspaceId, err := promptForWorkspaceIdIfUnified(ctx, authArguments, existingProfile) + if err != nil { + return err + } + switch { case configureCluster: w, err := databricks.NewWorkspaceClient((*databricks.Config)(&cfg)) @@ -201,13 +207,15 @@ depends on the existing profiles you have set in your configuration file if profileName != "" { err = databrickscfg.SaveToProfile(ctx, &config.Config{ - Profile: profileName, - Host: cfg.Host, - AuthType: cfg.AuthType, - AccountID: cfg.AccountID, - ClusterID: cfg.ClusterID, - ConfigFile: cfg.ConfigFile, - ServerlessComputeID: cfg.ServerlessComputeID, + Profile: profileName, + Host: cfg.Host, + AuthType: cfg.AuthType, + AccountID: cfg.AccountID, + WorkspaceId: workspaceId, + ClusterID: cfg.ClusterID, + ConfigFile: cfg.ConfigFile, + ServerlessComputeID: cfg.ServerlessComputeID, + Experimental_IsUnifiedHost: authArguments.IsUnifiedHost, }) if err != nil { return err @@ -233,7 +241,7 @@ depends on the existing profiles you have set in your configuration file // 1. --account-id flag. // 2. account-id from the specified profile, if available. // 3. Prompt the user for the account-id. -func setHostAndAccountId(ctx context.Context, existingProfile *profile.Profile, authArguments *auth.AuthArguments, args []string) error { +func setHostAndAccountId(ctx context.Context, cmd *cobra.Command, existingProfile *profile.Profile, authArguments *auth.AuthArguments, args []string) error { // If both [HOST] and --host are provided, return an error. host := authArguments.Host if len(args) > 0 && host != "" { @@ -259,11 +267,21 @@ func setHostAndAccountId(ctx context.Context, existingProfile *profile.Profile, } } + // Determine if the host is a unified host in the following order of precedence: + // 1. --experimental-is-unified-host flag (if explicitly set) + // 2. experimental_is_unified_host from the specified profile, if available + // 3. default to false if neither is provided. + if !cmd.Flag("experimental-is-unified-host").Changed { + if existingProfile != nil { + authArguments.IsUnifiedHost = existingProfile.Experimental_IsUnifiedHost + } + } + // If the account-id was not provided as a cmd line flag, try to read it from // the specified profile. - isAccountClient := (&config.Config{Host: authArguments.Host}).IsAccountClient() + isAccountHost := (&config.Config{Host: authArguments.Host, Experimental_IsUnifiedHost: authArguments.IsUnifiedHost}).GetHostType() != config.WorkspaceHost accountID := authArguments.AccountID - if isAccountClient && accountID == "" { + if isAccountHost && accountID == "" { if existingProfile != nil && existingProfile.AccountID != "" { authArguments.AccountID = existingProfile.AccountID } else { @@ -279,6 +297,28 @@ func setHostAndAccountId(ctx context.Context, existingProfile *profile.Profile, return nil } +// promptForWorkspaceIdIfUnified prompts for workspace ID if the host is unified. +// Returns the workspace ID from the profile if available, otherwise prompts the user. +func promptForWorkspaceIdIfUnified(ctx context.Context, authArguments *auth.AuthArguments, existingProfile *profile.Profile) (string, error) { + // Only prompt for workspace_id if the host is a unified host + if !authArguments.IsUnifiedHost { + return "", nil + } + + // If the existing profile has a workspace_id, use it + if existingProfile != nil && existingProfile.WorkspaceId != "" { + return existingProfile.WorkspaceId, nil + } + + // Prompt the user for workspace_id + workspaceId, err := promptForWorkspaceId(ctx) + if err != nil { + return "", err + } + + return workspaceId, nil +} + // getProfileName returns the default profile name for a given host/account ID. // If the account ID is provided, the profile name is "ACCOUNT-". // Otherwise, the profile name is the first part of the host URL. diff --git a/cmd/auth/login_test.go b/cmd/auth/login_test.go index 4a12dedbdd..a6658ecdb4 100644 --- a/cmd/auth/login_test.go +++ b/cmd/auth/login_test.go @@ -26,7 +26,8 @@ func TestSetHostDoesNotFailWithNoDatabrickscfg(t *testing.T) { existingProfile, err := loadProfileByName(ctx, "foo", profile.DefaultProfiler) assert.NoError(t, err) - err = setHostAndAccountId(ctx, existingProfile, &auth.AuthArguments{Host: "test"}, []string{}) + cmd := newLoginCommand(&auth.AuthArguments{}) + err = setHostAndAccountId(ctx, cmd, existingProfile, &auth.AuthArguments{Host: "test"}, []string{}) assert.NoError(t, err) } @@ -38,38 +39,40 @@ func TestSetHost(t *testing.T) { profile1 := loadTestProfile(t, ctx, "profile-1") profile2 := loadTestProfile(t, ctx, "profile-2") + cmd := newLoginCommand(&auth.AuthArguments{}) + // Test error when both flag and argument are provided authArguments.Host = "val from --host" - err := setHostAndAccountId(ctx, profile1, &authArguments, []string{"val from [HOST]"}) + err := setHostAndAccountId(ctx, cmd, profile1, &authArguments, []string{"val from [HOST]"}) assert.EqualError(t, err, "please only provide a host as an argument or a flag, not both") // Test setting host from flag authArguments.Host = "val from --host" - err = setHostAndAccountId(ctx, profile1, &authArguments, []string{}) + err = setHostAndAccountId(ctx, cmd, profile1, &authArguments, []string{}) assert.NoError(t, err) assert.Equal(t, "val from --host", authArguments.Host) // Test setting host from argument authArguments.Host = "" - err = setHostAndAccountId(ctx, profile1, &authArguments, []string{"val from [HOST]"}) + err = setHostAndAccountId(ctx, cmd, profile1, &authArguments, []string{"val from [HOST]"}) assert.NoError(t, err) assert.Equal(t, "val from [HOST]", authArguments.Host) // Test setting host from profile authArguments.Host = "" - err = setHostAndAccountId(ctx, profile1, &authArguments, []string{}) + err = setHostAndAccountId(ctx, cmd, profile1, &authArguments, []string{}) assert.NoError(t, err) assert.Equal(t, "https://www.host1.com", authArguments.Host) // Test setting host from profile authArguments.Host = "" - err = setHostAndAccountId(ctx, profile2, &authArguments, []string{}) + err = setHostAndAccountId(ctx, cmd, profile2, &authArguments, []string{}) assert.NoError(t, err) assert.Equal(t, "https://www.host2.com", authArguments.Host) // Test host is not set. Should prompt. authArguments.Host = "" - err = setHostAndAccountId(ctx, nil, &authArguments, []string{}) + err = setHostAndAccountId(ctx, cmd, nil, &authArguments, []string{}) assert.EqualError(t, err, "the command is being run in a non-interactive environment, please specify a host using --host") } @@ -80,16 +83,18 @@ func TestSetAccountId(t *testing.T) { accountProfile := loadTestProfile(t, ctx, "account-profile") + cmd := newLoginCommand(&auth.AuthArguments{}) + // Test setting account-id from flag authArguments.AccountID = "val from --account-id" - err := setHostAndAccountId(ctx, accountProfile, &authArguments, []string{}) + err := setHostAndAccountId(ctx, cmd, accountProfile, &authArguments, []string{}) assert.NoError(t, err) assert.Equal(t, "https://accounts.cloud.databricks.com", authArguments.Host) assert.Equal(t, "val from --account-id", authArguments.AccountID) // Test setting account_id from profile authArguments.AccountID = "" - err = setHostAndAccountId(ctx, accountProfile, &authArguments, []string{}) + err = setHostAndAccountId(ctx, cmd, accountProfile, &authArguments, []string{}) require.NoError(t, err) assert.Equal(t, "https://accounts.cloud.databricks.com", authArguments.Host) assert.Equal(t, "id-from-profile", authArguments.AccountID) @@ -97,7 +102,7 @@ func TestSetAccountId(t *testing.T) { // Neither flag nor profile account-id is set, should prompt authArguments.AccountID = "" authArguments.Host = "https://accounts.cloud.databricks.com" - err = setHostAndAccountId(ctx, nil, &authArguments, []string{}) + err = setHostAndAccountId(ctx, cmd, nil, &authArguments, []string{}) assert.EqualError(t, err, "the command is being run in a non-interactive environment, please specify an account ID using --account-id") } diff --git a/cmd/auth/profiles.go b/cmd/auth/profiles.go index 6f4bff5f5e..3293e858f0 100644 --- a/cmd/auth/profiles.go +++ b/cmd/auth/profiles.go @@ -51,7 +51,7 @@ func (c *profileMetadata) Load(ctx context.Context, configFilePath string, skipV return } - if cfg.IsAccountClient() { + if cfg.GetHostType() != config.WorkspaceHost { a, err := databricks.NewAccountClient((*databricks.Config)(cfg)) if err != nil { return diff --git a/cmd/auth/token.go b/cmd/auth/token.go index cf3873cb89..66ae13f40a 100644 --- a/cmd/auth/token.go +++ b/cmd/auth/token.go @@ -43,6 +43,7 @@ using a client ID and secret is not supported.`, } t, err := loadToken(ctx, loadTokenArgs{ + cmd: cmd, authArguments: authArguments, profileName: profileName, args: args, @@ -65,6 +66,9 @@ using a client ID and secret is not supported.`, } type loadTokenArgs struct { + // cmd is the cobra command, used to access flags like experimental-is-unified-host. + cmd *cobra.Command + // authArguments is the parsed auth arguments, including the host and optionally the account ID. authArguments *auth.AuthArguments @@ -98,7 +102,7 @@ func loadToken(ctx context.Context, args loadTokenArgs) (*oauth2.Token, error) { return nil, err } - err = setHostAndAccountId(ctx, existingProfile, args.authArguments, args.args) + err = setHostAndAccountId(ctx, args.cmd, existingProfile, args.authArguments, args.args) if err != nil { return nil, err } diff --git a/go.mod b/go.mod index 1bcda0a451..6b661a9a7f 100644 --- a/go.mod +++ b/go.mod @@ -75,3 +75,5 @@ require ( google.golang.org/grpc v1.75.1 // indirect google.golang.org/protobuf v1.36.9 // indirect ) + +replace github.com/databricks/databricks-sdk-go => ../databricks-sdk-go diff --git a/libs/auth/arguments.go b/libs/auth/arguments.go index 899fc19a9e..1eb725a24f 100644 --- a/libs/auth/arguments.go +++ b/libs/auth/arguments.go @@ -8,19 +8,23 @@ import ( // AuthArguments is a struct that contains the common arguments passed to // `databricks auth` commands. type AuthArguments struct { - Host string - AccountID string + Host string + AccountID string + IsUnifiedHost bool } // ToOAuthArgument converts the AuthArguments to an OAuthArgument from the Go SDK. func (a AuthArguments) ToOAuthArgument() (u2m.OAuthArgument, error) { cfg := &config.Config{ - Host: a.Host, - AccountID: a.AccountID, + Host: a.Host, + AccountID: a.AccountID, + Experimental_IsUnifiedHost: a.IsUnifiedHost, } host := cfg.CanonicalHostName() - if cfg.IsAccountClient() { + if cfg.GetHostType() == config.AccountHost { return u2m.NewBasicAccountOAuthArgument(host, cfg.AccountID) + } else if cfg.GetHostType() == config.UnifiedHost { + return u2m.NewBasicUnifiedOAuthArgument(host, cfg.AccountID) } return u2m.NewBasicWorkspaceOAuthArgument(host) } diff --git a/libs/auth/error.go b/libs/auth/error.go index 5311bea965..f10b5833fe 100644 --- a/libs/auth/error.go +++ b/libs/auth/error.go @@ -13,7 +13,7 @@ import ( func RewriteAuthError(ctx context.Context, host, accountId, profile string, err error) (bool, error) { target := &u2m.InvalidRefreshTokenError{} if errors.As(err, &target) { - oauthArgument, err := AuthArguments{host, accountId}.ToOAuthArgument() + oauthArgument, err := AuthArguments{host, accountId, false}.ToOAuthArgument() // TODO: pass the IsUnifiedHost flag if err != nil { return false, err } diff --git a/libs/databrickscfg/profile/file.go b/libs/databrickscfg/profile/file.go index e9a5aa3a2a..bec9e6ac9d 100644 --- a/libs/databrickscfg/profile/file.go +++ b/libs/databrickscfg/profile/file.go @@ -79,11 +79,13 @@ func (f FileProfilerImpl) LoadProfiles(ctx context.Context, fn ProfileMatchFunct continue } profile := Profile{ - Name: v.Name(), - Host: host, - AccountID: all["account_id"], - ClusterID: all["cluster_id"], - ServerlessComputeID: all["serverless_compute_id"], + Name: v.Name(), + Host: host, + AccountID: all["account_id"], + WorkspaceId: all["workspace_id"], + ClusterID: all["cluster_id"], + ServerlessComputeID: all["serverless_compute_id"], + Experimental_IsUnifiedHost: all["experimental_is_unified_host"] == "true", } if fn(profile) { profiles = append(profiles, profile) diff --git a/libs/databrickscfg/profile/file_test.go b/libs/databrickscfg/profile/file_test.go index 6bcaec4b77..d5b97e84d6 100644 --- a/libs/databrickscfg/profile/file_test.go +++ b/libs/databrickscfg/profile/file_test.go @@ -80,5 +80,32 @@ func TestLoadProfilesMatchAccount(t *testing.T) { profiler := FileProfilerImpl{} profiles, err := profiler.LoadProfiles(ctx, MatchAccountProfiles) require.NoError(t, err) - assert.Equal(t, []string{"acc"}, profiles.Names()) + assert.Equal(t, []string{"acc", "unified", "unified-with-workspace"}, profiles.Names()) +} + +func TestLoadProfilesWithExperimentalIsUnifiedHost(t *testing.T) { + ctx := context.Background() + ctx = env.Set(ctx, "DATABRICKS_CONFIG_FILE", "./testdata/databrickscfg") + profiler := FileProfilerImpl{} + profiles, err := profiler.LoadProfiles(ctx, WithName("unified")) + require.NoError(t, err) + require.Len(t, profiles, 1) + assert.Equal(t, "unified", profiles[0].Name) + assert.Equal(t, "https://unified.databricks.com", profiles[0].Host) + assert.Equal(t, "def", profiles[0].AccountID) + assert.True(t, profiles[0].Experimental_IsUnifiedHost) +} + +func TestLoadProfilesWithWorkspaceId(t *testing.T) { + ctx := context.Background() + ctx = env.Set(ctx, "DATABRICKS_CONFIG_FILE", "./testdata/databrickscfg") + profiler := FileProfilerImpl{} + profiles, err := profiler.LoadProfiles(ctx, WithName("unified-with-workspace")) + require.NoError(t, err) + require.Len(t, profiles, 1) + assert.Equal(t, "unified-with-workspace", profiles[0].Name) + assert.Equal(t, "https://unified.databricks.com", profiles[0].Host) + assert.Equal(t, "def", profiles[0].AccountID) + assert.Equal(t, "123456789", profiles[0].WorkspaceId) + assert.True(t, profiles[0].Experimental_IsUnifiedHost) } diff --git a/libs/databrickscfg/profile/profile.go b/libs/databrickscfg/profile/profile.go index d2c3a88d5a..442e62b5b6 100644 --- a/libs/databrickscfg/profile/profile.go +++ b/libs/databrickscfg/profile/profile.go @@ -10,11 +10,13 @@ import ( // It should only be used for prompting and filtering. // Use its name to construct a config.Config. type Profile struct { - Name string - Host string - AccountID string - ClusterID string - ServerlessComputeID string + Name string + Host string + AccountID string + WorkspaceId string + ClusterID string + ServerlessComputeID string + Experimental_IsUnifiedHost bool } func (p Profile) Cloud() string { diff --git a/libs/databrickscfg/profile/testdata/databrickscfg b/libs/databrickscfg/profile/testdata/databrickscfg index ba045c6c28..f14241bac1 100644 --- a/libs/databrickscfg/profile/testdata/databrickscfg +++ b/libs/databrickscfg/profile/testdata/databrickscfg @@ -18,6 +18,17 @@ token = foo1 host = https://accounts.cloud.databricks.com account_id = abc +[unified] +host = https://unified.databricks.com +account_id = def +experimental_is_unified_host = true + +[unified-with-workspace] +host = https://unified.databricks.com +account_id = def +workspace_id = 123456789 +experimental_is_unified_host = true + # Duplicate entry for https://foo [foo2] host = https://foo From 54fc4a508acdaa1bb7ee4c63b3b9402d0cbd7f03 Mon Sep 17 00:00:00 2001 From: J H <237805758+jh-db@users.noreply.github.com> Date: Fri, 24 Oct 2025 14:02:59 +0200 Subject: [PATCH 3/7] remove replace --- go.mod | 2 -- 1 file changed, 2 deletions(-) diff --git a/go.mod b/go.mod index 6b661a9a7f..1bcda0a451 100644 --- a/go.mod +++ b/go.mod @@ -75,5 +75,3 @@ require ( google.golang.org/grpc v1.75.1 // indirect google.golang.org/protobuf v1.36.9 // indirect ) - -replace github.com/databricks/databricks-sdk-go => ../databricks-sdk-go From fe13be0cad1bc8ee03f18b9b9ce1fdc201038b6e Mon Sep 17 00:00:00 2001 From: J H <237805758+jh-db@users.noreply.github.com> Date: Fri, 31 Oct 2025 07:29:16 +0100 Subject: [PATCH 4/7] fix auth profiles --- cmd/auth/login.go | 2 +- cmd/auth/profiles.go | 2 +- go.mod | 2 ++ libs/auth/arguments.go | 4 ++-- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/cmd/auth/login.go b/cmd/auth/login.go index fc06df319d..f6fb0d0415 100644 --- a/cmd/auth/login.go +++ b/cmd/auth/login.go @@ -279,7 +279,7 @@ func setHostAndAccountId(ctx context.Context, cmd *cobra.Command, existingProfil // If the account-id was not provided as a cmd line flag, try to read it from // the specified profile. - isAccountHost := (&config.Config{Host: authArguments.Host, Experimental_IsUnifiedHost: authArguments.IsUnifiedHost}).GetHostType() != config.WorkspaceHost + isAccountHost := (&config.Config{Host: authArguments.Host, Experimental_IsUnifiedHost: authArguments.IsUnifiedHost}).HostType() != config.WorkspaceHost accountID := authArguments.AccountID if isAccountHost && accountID == "" { if existingProfile != nil && existingProfile.AccountID != "" { diff --git a/cmd/auth/profiles.go b/cmd/auth/profiles.go index 3293e858f0..a5c547b409 100644 --- a/cmd/auth/profiles.go +++ b/cmd/auth/profiles.go @@ -51,7 +51,7 @@ func (c *profileMetadata) Load(ctx context.Context, configFilePath string, skipV return } - if cfg.GetHostType() != config.WorkspaceHost { + if cfg.ConfigType() == config.AccountConfig { a, err := databricks.NewAccountClient((*databricks.Config)(cfg)) if err != nil { return diff --git a/go.mod b/go.mod index 1bcda0a451..6b661a9a7f 100644 --- a/go.mod +++ b/go.mod @@ -75,3 +75,5 @@ require ( google.golang.org/grpc v1.75.1 // indirect google.golang.org/protobuf v1.36.9 // indirect ) + +replace github.com/databricks/databricks-sdk-go => ../databricks-sdk-go diff --git a/libs/auth/arguments.go b/libs/auth/arguments.go index 1eb725a24f..41f725579b 100644 --- a/libs/auth/arguments.go +++ b/libs/auth/arguments.go @@ -21,9 +21,9 @@ func (a AuthArguments) ToOAuthArgument() (u2m.OAuthArgument, error) { Experimental_IsUnifiedHost: a.IsUnifiedHost, } host := cfg.CanonicalHostName() - if cfg.GetHostType() == config.AccountHost { + if cfg.HostType() == config.AccountHost { return u2m.NewBasicAccountOAuthArgument(host, cfg.AccountID) - } else if cfg.GetHostType() == config.UnifiedHost { + } else if cfg.HostType() == config.UnifiedHost { return u2m.NewBasicUnifiedOAuthArgument(host, cfg.AccountID) } return u2m.NewBasicWorkspaceOAuthArgument(host) From 9e5ee9ea96bb66484d7305989bda8cc9dce33be8 Mon Sep 17 00:00:00 2001 From: J H <237805758+jh-db@users.noreply.github.com> Date: Mon, 3 Nov 2025 10:47:21 +0100 Subject: [PATCH 5/7] update to v90 of go sdk --- go.mod | 2 -- 1 file changed, 2 deletions(-) diff --git a/go.mod b/go.mod index 6b661a9a7f..1bcda0a451 100644 --- a/go.mod +++ b/go.mod @@ -75,5 +75,3 @@ require ( google.golang.org/grpc v1.75.1 // indirect google.golang.org/protobuf v1.36.9 // indirect ) - -replace github.com/databricks/databricks-sdk-go => ../databricks-sdk-go From 8539ebaf65d67c310b8fd357104b2052541cbd53 Mon Sep 17 00:00:00 2001 From: J H <237805758+jh-db@users.noreply.github.com> Date: Mon, 3 Nov 2025 11:50:27 +0100 Subject: [PATCH 6/7] address comments --- cmd/auth/auth.go | 2 +- cmd/auth/login.go | 18 ++++++------------ cmd/auth/login_test.go | 21 ++++++++------------- cmd/auth/token.go | 9 +++++++-- cmd/root/auth.go | 2 +- libs/auth/error.go | 4 ++-- 6 files changed, 25 insertions(+), 31 deletions(-) diff --git a/cmd/auth/auth.go b/cmd/auth/auth.go index 01bed59516..4d8c768ee1 100644 --- a/cmd/auth/auth.go +++ b/cmd/auth/auth.go @@ -58,7 +58,7 @@ func promptForAccountID(ctx context.Context) (string, error) { } func promptForWorkspaceId(ctx context.Context) (string, error) { - if !cmdio.IsInTTY(ctx) { + if !cmdio.IsPromptSupported(ctx) { return "", nil } diff --git a/cmd/auth/login.go b/cmd/auth/login.go index f6fb0d0415..993c909df6 100644 --- a/cmd/auth/login.go +++ b/cmd/auth/login.go @@ -132,7 +132,11 @@ depends on the existing profiles you have set in your configuration file if err != nil { return err } - err = setHostAndAccountId(ctx, cmd, existingProfile, authArguments, args) + // Set IsUnifiedHost from the profile if the flag wasn't explicitly set. + if !cmd.Flag("experimental-is-unified-host").Changed && existingProfile != nil { + authArguments.IsUnifiedHost = existingProfile.Experimental_IsUnifiedHost + } + err = setHostAndAccountId(ctx, existingProfile, authArguments, args) if err != nil { return err } @@ -241,7 +245,7 @@ depends on the existing profiles you have set in your configuration file // 1. --account-id flag. // 2. account-id from the specified profile, if available. // 3. Prompt the user for the account-id. -func setHostAndAccountId(ctx context.Context, cmd *cobra.Command, existingProfile *profile.Profile, authArguments *auth.AuthArguments, args []string) error { +func setHostAndAccountId(ctx context.Context, existingProfile *profile.Profile, authArguments *auth.AuthArguments, args []string) error { // If both [HOST] and --host are provided, return an error. host := authArguments.Host if len(args) > 0 && host != "" { @@ -267,16 +271,6 @@ func setHostAndAccountId(ctx context.Context, cmd *cobra.Command, existingProfil } } - // Determine if the host is a unified host in the following order of precedence: - // 1. --experimental-is-unified-host flag (if explicitly set) - // 2. experimental_is_unified_host from the specified profile, if available - // 3. default to false if neither is provided. - if !cmd.Flag("experimental-is-unified-host").Changed { - if existingProfile != nil { - authArguments.IsUnifiedHost = existingProfile.Experimental_IsUnifiedHost - } - } - // If the account-id was not provided as a cmd line flag, try to read it from // the specified profile. isAccountHost := (&config.Config{Host: authArguments.Host, Experimental_IsUnifiedHost: authArguments.IsUnifiedHost}).HostType() != config.WorkspaceHost diff --git a/cmd/auth/login_test.go b/cmd/auth/login_test.go index a6658ecdb4..775f0d924b 100644 --- a/cmd/auth/login_test.go +++ b/cmd/auth/login_test.go @@ -26,8 +26,7 @@ func TestSetHostDoesNotFailWithNoDatabrickscfg(t *testing.T) { existingProfile, err := loadProfileByName(ctx, "foo", profile.DefaultProfiler) assert.NoError(t, err) - cmd := newLoginCommand(&auth.AuthArguments{}) - err = setHostAndAccountId(ctx, cmd, existingProfile, &auth.AuthArguments{Host: "test"}, []string{}) + err = setHostAndAccountId(ctx, existingProfile, &auth.AuthArguments{Host: "test"}, []string{}) assert.NoError(t, err) } @@ -39,34 +38,32 @@ func TestSetHost(t *testing.T) { profile1 := loadTestProfile(t, ctx, "profile-1") profile2 := loadTestProfile(t, ctx, "profile-2") - cmd := newLoginCommand(&auth.AuthArguments{}) - // Test error when both flag and argument are provided authArguments.Host = "val from --host" - err := setHostAndAccountId(ctx, cmd, profile1, &authArguments, []string{"val from [HOST]"}) + err := setHostAndAccountId(ctx, profile1, &authArguments, []string{"val from [HOST]"}) assert.EqualError(t, err, "please only provide a host as an argument or a flag, not both") // Test setting host from flag authArguments.Host = "val from --host" - err = setHostAndAccountId(ctx, cmd, profile1, &authArguments, []string{}) + err = setHostAndAccountId(ctx, profile1, &authArguments, []string{}) assert.NoError(t, err) assert.Equal(t, "val from --host", authArguments.Host) // Test setting host from argument authArguments.Host = "" - err = setHostAndAccountId(ctx, cmd, profile1, &authArguments, []string{"val from [HOST]"}) + err = setHostAndAccountId(ctx, profile1, &authArguments, []string{"val from [HOST]"}) assert.NoError(t, err) assert.Equal(t, "val from [HOST]", authArguments.Host) // Test setting host from profile authArguments.Host = "" - err = setHostAndAccountId(ctx, cmd, profile1, &authArguments, []string{}) + err = setHostAndAccountId(ctx, profile1, &authArguments, []string{}) assert.NoError(t, err) assert.Equal(t, "https://www.host1.com", authArguments.Host) // Test setting host from profile authArguments.Host = "" - err = setHostAndAccountId(ctx, cmd, profile2, &authArguments, []string{}) + err = setHostAndAccountId(ctx, profile2, &authArguments, []string{}) assert.NoError(t, err) assert.Equal(t, "https://www.host2.com", authArguments.Host) @@ -83,18 +80,16 @@ func TestSetAccountId(t *testing.T) { accountProfile := loadTestProfile(t, ctx, "account-profile") - cmd := newLoginCommand(&auth.AuthArguments{}) - // Test setting account-id from flag authArguments.AccountID = "val from --account-id" - err := setHostAndAccountId(ctx, cmd, accountProfile, &authArguments, []string{}) + err := setHostAndAccountId(ctx, accountProfile, &authArguments, []string{}) assert.NoError(t, err) assert.Equal(t, "https://accounts.cloud.databricks.com", authArguments.Host) assert.Equal(t, "val from --account-id", authArguments.AccountID) // Test setting account_id from profile authArguments.AccountID = "" - err = setHostAndAccountId(ctx, cmd, accountProfile, &authArguments, []string{}) + err = setHostAndAccountId(ctx, accountProfile, &authArguments, []string{}) require.NoError(t, err) assert.Equal(t, "https://accounts.cloud.databricks.com", authArguments.Host) assert.Equal(t, "id-from-profile", authArguments.AccountID) diff --git a/cmd/auth/token.go b/cmd/auth/token.go index 66ae13f40a..ca8538f78d 100644 --- a/cmd/auth/token.go +++ b/cmd/auth/token.go @@ -102,7 +102,12 @@ func loadToken(ctx context.Context, args loadTokenArgs) (*oauth2.Token, error) { return nil, err } - err = setHostAndAccountId(ctx, args.cmd, existingProfile, args.authArguments, args.args) + // Set IsUnifiedHost from the profile if the flag wasn't explicitly set. + if !args.cmd.Flag("experimental-is-unified-host").Changed && existingProfile != nil { + args.authArguments.IsUnifiedHost = existingProfile.Experimental_IsUnifiedHost + } + + err = setHostAndAccountId(ctx, existingProfile, args.authArguments, args.args) if err != nil { return nil, err } @@ -133,7 +138,7 @@ func loadToken(ctx context.Context, args loadTokenArgs) (*oauth2.Token, error) { // This is captured in an acceptance test under "cmd/auth/token". err = errors.New("cache: databricks OAuth is not configured for this host") } - if rewritten, rewrittenErr := auth.RewriteAuthError(ctx, args.authArguments.Host, args.authArguments.AccountID, args.profileName, err); rewritten { + if rewritten, rewrittenErr := auth.RewriteAuthError(ctx, args.authArguments.Host, args.authArguments.AccountID, args.profileName, args.authArguments.IsUnifiedHost, err); rewritten { return nil, rewrittenErr } helpMsg := helpfulError(ctx, args.profileName, oauthArgument) diff --git a/cmd/root/auth.go b/cmd/root/auth.go index a1118b5a48..81ac48d8f8 100644 --- a/cmd/root/auth.go +++ b/cmd/root/auth.go @@ -314,7 +314,7 @@ func emptyHttpRequest(ctx context.Context) *http.Request { } func renderError(ctx context.Context, cfg *config.Config, err error) error { - if rewritten, newErr := auth.RewriteAuthError(ctx, cfg.Host, cfg.AccountID, cfg.Profile, err); rewritten { + if rewritten, newErr := auth.RewriteAuthError(ctx, cfg.Host, cfg.AccountID, cfg.Profile, cfg.Experimental_IsUnifiedHost, err); rewritten { return newErr } return err diff --git a/libs/auth/error.go b/libs/auth/error.go index f10b5833fe..68c9736f4f 100644 --- a/libs/auth/error.go +++ b/libs/auth/error.go @@ -10,10 +10,10 @@ import ( // RewriteAuthError rewrites the error message for invalid refresh token error. // It returns whether the error was rewritten and the rewritten error. -func RewriteAuthError(ctx context.Context, host, accountId, profile string, err error) (bool, error) { +func RewriteAuthError(ctx context.Context, host, accountId, profile string, isUnifiedHost bool, err error) (bool, error) { target := &u2m.InvalidRefreshTokenError{} if errors.As(err, &target) { - oauthArgument, err := AuthArguments{host, accountId, false}.ToOAuthArgument() // TODO: pass the IsUnifiedHost flag + oauthArgument, err := AuthArguments{Host: host, AccountID: accountId, IsUnifiedHost: isUnifiedHost}.ToOAuthArgument() if err != nil { return false, err } From 001f31159df3999af70ebcea4dc3dfac6e0f156a Mon Sep 17 00:00:00 2001 From: J H <237805758+jh-db@users.noreply.github.com> Date: Wed, 5 Nov 2025 11:12:32 +0100 Subject: [PATCH 7/7] swag tests --- cmd/auth/login_test.go | 76 +++++++++++++++++++++++++ cmd/auth/testdata/.databrickscfg | 11 ++++ cmd/root/auth_test.go | 62 ++++++++++++++++++++ libs/auth/arguments_test.go | 40 ++++++++++++- libs/auth/error.go | 2 + libs/databrickscfg/profile/file_test.go | 48 ++++++++++++++++ 6 files changed, 238 insertions(+), 1 deletion(-) diff --git a/cmd/auth/login_test.go b/cmd/auth/login_test.go index 775f0d924b..776f41fef1 100644 --- a/cmd/auth/login_test.go +++ b/cmd/auth/login_test.go @@ -101,6 +101,82 @@ func TestSetAccountId(t *testing.T) { assert.EqualError(t, err, "the command is being run in a non-interactive environment, please specify an account ID using --account-id") } +func TestSetHostAndAccountIdUnifiedHost(t *testing.T) { + var authArguments auth.AuthArguments + t.Setenv("DATABRICKS_CONFIG_FILE", "./testdata/.databrickscfg") + ctx, _ := cmdio.SetupTest(context.Background(), cmdio.TestOptions{}) + + unifiedProfile := loadTestProfile(t, ctx, "unified-profile") + + // Test unified host requires account ID from flag + authArguments.Host = "https://unified.databricks.com" + authArguments.IsUnifiedHost = true + authArguments.AccountID = "val-from-flag" + err := setHostAndAccountId(ctx, unifiedProfile, &authArguments, []string{}) + assert.NoError(t, err) + assert.Equal(t, "https://unified.databricks.com", authArguments.Host) + assert.Equal(t, "val-from-flag", authArguments.AccountID) + + // Test unified host uses account_id from profile + authArguments.AccountID = "" + err = setHostAndAccountId(ctx, unifiedProfile, &authArguments, []string{}) + require.NoError(t, err) + assert.Equal(t, "https://unified.databricks.com", authArguments.Host) + assert.Equal(t, "unified-account-id", authArguments.AccountID) + + // Test unified host without account ID should prompt + authArguments.AccountID = "" + authArguments.Host = "https://unified.databricks.com" + authArguments.IsUnifiedHost = true + err = setHostAndAccountId(ctx, nil, &authArguments, []string{}) + assert.EqualError(t, err, "the command is being run in a non-interactive environment, please specify an account ID using --account-id") +} + +func TestPromptForWorkspaceIdIfUnified(t *testing.T) { + ctx, _ := cmdio.SetupTest(context.Background(), cmdio.TestOptions{}) + t.Setenv("DATABRICKS_CONFIG_FILE", "./testdata/.databrickscfg") + + // Test non-unified host doesn't prompt for workspace ID + authArgs := &auth.AuthArguments{ + Host: "https://workspace.cloud.databricks.com", + IsUnifiedHost: false, + } + workspaceId, err := promptForWorkspaceIdIfUnified(ctx, authArgs, nil) + require.NoError(t, err) + assert.Equal(t, "", workspaceId) + + // Test unified host with existing profile workspace_id + unifiedProfile := loadTestProfile(t, ctx, "unified-with-workspace") + authArgs = &auth.AuthArguments{ + Host: "https://unified.databricks.com", + IsUnifiedHost: true, + } + workspaceId, err = promptForWorkspaceIdIfUnified(ctx, authArgs, unifiedProfile) + require.NoError(t, err) + assert.Equal(t, "123456789", workspaceId) + + // Test unified host without profile should prompt (will error in non-interactive) + authArgs = &auth.AuthArguments{ + Host: "https://unified.databricks.com", + IsUnifiedHost: true, + } + workspaceId, err = promptForWorkspaceIdIfUnified(ctx, authArgs, nil) + // In non-interactive mode, this should return empty string, not error + require.NoError(t, err) + assert.Equal(t, "", workspaceId) +} + +func TestLoadProfilePreservesUnifiedHostFlag(t *testing.T) { + ctx := context.Background() + t.Setenv("DATABRICKS_CONFIG_FILE", "./testdata/.databrickscfg") + + profile, err := loadProfileByName(ctx, "unified-profile", profile.DefaultProfiler) + require.NoError(t, err) + require.NotNil(t, profile) + assert.True(t, profile.Experimental_IsUnifiedHost) + assert.Equal(t, "unified-account-id", profile.AccountID) +} + func TestLoadProfileByNameAndClusterID(t *testing.T) { testCases := []struct { name string diff --git a/cmd/auth/testdata/.databrickscfg b/cmd/auth/testdata/.databrickscfg index 192839b9be..1807ad1da3 100644 --- a/cmd/auth/testdata/.databrickscfg +++ b/cmd/auth/testdata/.databrickscfg @@ -15,3 +15,14 @@ cluster_id = cluster-from-config [invalid-profile] # This profile is missing the required 'host' field cluster_id = some-cluster-id + +[unified-profile] +host = https://unified.databricks.com +account_id = unified-account-id +experimental_is_unified_host = true + +[unified-with-workspace] +host = https://unified.databricks.com +account_id = unified-account-id +workspace_id = 123456789 +experimental_is_unified_host = true diff --git a/cmd/root/auth_test.go b/cmd/root/auth_test.go index 78f0dc9c8a..332e51c8c9 100644 --- a/cmd/root/auth_test.go +++ b/cmd/root/auth_test.go @@ -323,3 +323,65 @@ func TestMustAnyClientWithEmptyDatabricksCfg(t *testing.T) { _, err = MustAnyClient(cmd, []string{}) require.ErrorContains(t, err, "does not contain account profiles") } + +func TestMustAccountClientWithUnifiedHost(t *testing.T) { + testutil.CleanupEnvironment(t) + + dir := t.TempDir() + configFile := filepath.Join(dir, ".databrickscfg") + err := os.WriteFile( + configFile, + []byte(` + [unified-account] + host = https://unified.databricks.com + account_id = test-unified-account + token = foobar + experimental_is_unified_host = true + `), + 0o755) + require.NoError(t, err) + + cmd := New(context.Background()) + + t.Setenv("DATABRICKS_CONFIG_FILE", configFile) + t.Setenv("PATH", "/nothing") + err = MustAccountClient(cmd, []string{}) + require.NoError(t, err) + + // Verify account client was created + a := cmdctx.AccountClient(cmd.Context()) + require.NotNil(t, a) +} + +func TestMustAnyClientWithUnifiedHostAccountProfile(t *testing.T) { + testutil.CleanupEnvironment(t) + + dir := t.TempDir() + configFile := filepath.Join(dir, ".databrickscfg") + err := os.WriteFile( + configFile, + []byte(` + [unified-account] + host = https://unified.databricks.com + account_id = test-unified-account + token = foobar + experimental_is_unified_host = true + `), + 0o755) + require.NoError(t, err) + + ctx, tt := cmdio.SetupTest(context.Background(), cmdio.TestOptions{PromptSupported: true}) + t.Cleanup(tt.Done) + cmd := New(ctx) + + t.Setenv("DATABRICKS_CONFIG_FILE", configFile) + t.Setenv("PATH", "/nothing") + isAccount, err := MustAnyClient(cmd, []string{}) + require.NoError(t, err) + // Unified hosts without workspace_id should create account clients + require.True(t, isAccount) + + // Verify account client was created + a := cmdctx.AccountClient(cmd.Context()) + require.NotNil(t, a) +} diff --git a/libs/auth/arguments_test.go b/libs/auth/arguments_test.go index d75827a771..98962fbbc9 100644 --- a/libs/auth/arguments_test.go +++ b/libs/auth/arguments_test.go @@ -5,6 +5,7 @@ import ( "github.com/databricks/databricks-sdk-go/credentials/u2m" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func TestToOAuthArgument(t *testing.T) { @@ -58,6 +59,24 @@ func TestToOAuthArgument(t *testing.T) { }, wantHost: "https://my-workspace.cloud.databricks.com", }, + { + name: "unified host with account ID", + args: AuthArguments{ + Host: "https://unified.databricks.com", + AccountID: "test-account-123", + IsUnifiedHost: true, + }, + wantHost: "https://unified.databricks.com", + }, + { + name: "unified host with no scheme", + args: AuthArguments{ + Host: "unified.databricks.com", + AccountID: "test-account-123", + IsUnifiedHost: true, + }, + wantHost: "https://unified.databricks.com", + }, } for _, tt := range tests { @@ -70,7 +89,11 @@ func TestToOAuthArgument(t *testing.T) { assert.NoError(t, err) // Check if we got the right type of argument and verify the hostname - if tt.args.AccountID != "" { + if tt.args.IsUnifiedHost { + arg, ok := got.(u2m.UnifiedOAuthArgument) + assert.True(t, ok, "expected UnifiedOAuthArgument for unified host") + assert.Equal(t, tt.wantHost, arg.GetHost()) + } else if tt.args.AccountID != "" { arg, ok := got.(u2m.AccountOAuthArgument) assert.True(t, ok, "expected AccountOAuthArgument for account ID") assert.Equal(t, tt.wantHost, arg.GetAccountHost()) @@ -82,3 +105,18 @@ func TestToOAuthArgument(t *testing.T) { }) } } + +func TestToOAuthArgumentUnifiedHostRequiresAccountID(t *testing.T) { + authArgs := AuthArguments{ + Host: "https://unified.databricks.com", + IsUnifiedHost: true, + // Missing AccountID + } + + arg, err := authArgs.ToOAuthArgument() + require.NoError(t, err) + // The SDK returns a valid UnifiedOAuthArgument even without account ID + // Validation happens at a different layer + _, ok := arg.(u2m.UnifiedOAuthArgument) + assert.True(t, ok, "expected UnifiedOAuthArgument for unified host") +} diff --git a/libs/auth/error.go b/libs/auth/error.go index 68c9736f4f..8e86dbc9fb 100644 --- a/libs/auth/error.go +++ b/libs/auth/error.go @@ -35,6 +35,8 @@ func BuildLoginCommand(ctx context.Context, profile string, arg u2m.OAuthArgumen cmd = append(cmd, "--profile", profile) } else { switch arg := arg.(type) { + case u2m.UnifiedOAuthArgument: + cmd = append(cmd, "--host", arg.GetHost(), "--account-id", arg.GetAccountId(), "--experimental-is-unified-host") case u2m.AccountOAuthArgument: cmd = append(cmd, "--host", arg.GetAccountHost(), "--account-id", arg.GetAccountId()) case u2m.WorkspaceOAuthArgument: diff --git a/libs/databrickscfg/profile/file_test.go b/libs/databrickscfg/profile/file_test.go index d5b97e84d6..55b799a027 100644 --- a/libs/databrickscfg/profile/file_test.go +++ b/libs/databrickscfg/profile/file_test.go @@ -109,3 +109,51 @@ func TestLoadProfilesWithWorkspaceId(t *testing.T) { assert.Equal(t, "123456789", profiles[0].WorkspaceId) assert.True(t, profiles[0].Experimental_IsUnifiedHost) } + +func TestMatchAccountProfilesIncludesUnifiedHosts(t *testing.T) { + ctx := context.Background() + ctx = env.Set(ctx, "DATABRICKS_CONFIG_FILE", "./testdata/databrickscfg") + profiler := FileProfilerImpl{} + profiles, err := profiler.LoadProfiles(ctx, MatchAccountProfiles) + require.NoError(t, err) + + // Should include both regular account profiles and unified host profiles + names := profiles.Names() + assert.Contains(t, names, "acc") + assert.Contains(t, names, "unified") + assert.Contains(t, names, "unified-with-workspace") +} + +func TestUnifiedHostProfileWithoutAccountID(t *testing.T) { + ctx := context.Background() + ctx = env.Set(ctx, "DATABRICKS_CONFIG_FILE", "./testdata/databrickscfg") + profiler := FileProfilerImpl{} + + // Unified host without account_id should still load (validation happens later) + profiles, err := profiler.LoadProfiles(ctx, WithName("unified")) + require.NoError(t, err) + require.Len(t, profiles, 1) + assert.True(t, profiles[0].Experimental_IsUnifiedHost) +} + +func TestExperimentalIsUnifiedHostParsingCaseSensitivity(t *testing.T) { + // This test verifies that the experimental_is_unified_host field + // is correctly parsed from the config file. The parsing should be + // case-sensitive and only accept "true" (lowercase). + ctx := context.Background() + ctx = env.Set(ctx, "DATABRICKS_CONFIG_FILE", "./testdata/databrickscfg") + profiler := FileProfilerImpl{} + + profiles, err := profiler.LoadProfiles(ctx, WithName("unified")) + require.NoError(t, err) + require.Len(t, profiles, 1) + + // Verify the flag is correctly set to true + assert.True(t, profiles[0].Experimental_IsUnifiedHost) + + // Load a non-unified profile to verify it defaults to false + profiles, err = profiler.LoadProfiles(ctx, WithName("DEFAULT")) + require.NoError(t, err) + require.Len(t, profiles, 1) + assert.False(t, profiles[0].Experimental_IsUnifiedHost) +}