steve/databricks-cli
steve
/
databricks-cli
mirror of https://github.com/databricks/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add documentation for positional args in commands generated from the Databricks OpenAPI specification (#1033) 

## Changes
This PR adds documentation for positional arguments in commands that are
generated from the openapi spec.

Note: the changes to `.gitattributes` will be revert / properly fixed in
https://github.com/databricks/cli/pull/1012
This commit is contained in:
shreyas-goenka 2023-11-30 17:22:23 +01:00 committed by GitHub
parent bdef0f7b23
commit 76840176e3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
73 changed files with 1714 additions and 356 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
.codegen/service.go.tmpl
View File

@ -126,11 +126,28 @@ func new{{.PascalName}}() *cobra.Command {
{{- $hasRequiredArgs := and (not $hasIdPrompt) $hasPosArgs -}}
{{- $hasSingleRequiredRequestBodyFieldWithPrompt := and (and $hasIdPrompt .Request) (eq 1 (len .Request.RequiredRequestBodyFields)) -}}
{{- $atleastOneArgumentWithDescription := false -}}
{{- if $hasPosArgs -}}
{{- range .Request.RequiredFields -}}
{{- if .HasComment -}}
{{- $atleastOneArgumentWithDescription = true -}}
{{- break -}}
{{- end -}}
{{- end -}}
{{- end -}}
cmd.Use = "{{.KebabName}}{{if $hasPosArgs}}{{range .Request.RequiredFields}} {{.ConstantName}}{{end}}{{end}}"
{{- if .Description }}
cmd.Short = `{{.Summary | without "`"}}`
cmd.Long = `{{.Comment " " 80 | without "`"}}`
cmd.Long = `{{.Comment " " 80 | without "`"}}
{{- if $atleastOneArgumentWithDescription }}
Arguments:
{{- range .Request.RequiredFields }}
{{ .ConstantName }}: {{.Comment " " 80 | without "`"}}
{{- end -}}
{{- end -}}
`
{{- end }}
{{- if .IsPrivatePreview }}

3
.gitattributes vendored
View File

@ -83,6 +83,3 @@ cmd/workspace/warehouses/warehouses.go linguist-generated=true
cmd/workspace/workspace-bindings/workspace-bindings.go linguist-generated=true
cmd/workspace/workspace-conf/workspace-conf.go linguist-generated=true
cmd/workspace/workspace/workspace.go linguist-generated=true
# Hide diff for Go structs generated from databricks terraform provider schema
bundle/internal/tf/schema/*.go linguist-generated=true

18
cmd/account/access-control/access-control.go generated
View File

@ -59,7 +59,10 @@ func newGetAssignableRolesForResource() *cobra.Command {
Gets all the roles that can be granted on an account level resource. A role is
grantable if the rule set on the resource can contain an access rule of the
role.`
role.
Arguments:
RESOURCE: The resource name for which assignable roles will be listed.`
cmd.Annotations = make(map[string]string)
@ -122,7 +125,18 @@ func newGetRuleSet() *cobra.Command {
Get a rule set by its name. A rule set is always attached to a resource and
contains a list of access rules on the said resource. Currently only a default
rule set for each resource is supported.`
rule set for each resource is supported.
Arguments:
NAME: The ruleset name associated with the request.
ETAG: Etag used for versioning. The response is at least as fresh as the eTag
provided. Etag is used for optimistic concurrency control as a way to help
prevent simultaneous updates of a rule set from overwriting each other. It
is strongly suggested that systems make use of the etag in the read ->
modify -> write pattern to perform rule set updates in order to avoid race
conditions that is get an etag from a GET rule set request, and pass it
with the PUT update request to identify the rule set version you are
updating.`
cmd.Annotations = make(map[string]string)

8
cmd/account/billable-usage/billable-usage.go generated
View File

@ -64,7 +64,13 @@ func newDownload() *cobra.Command {
this API may hit a timeout after a few minutes. If you experience this, try to
mitigate by calling the API with narrower date ranges.
[CSV file schema]: https://docs.databricks.com/administration-guide/account-settings/usage-analysis.html#schema`
[CSV file schema]: https://docs.databricks.com/administration-guide/account-settings/usage-analysis.html#schema
Arguments:
START_MONTH: Format: YYYY-MM. First month to return billable usage logs for. This
field is required.
END_MONTH: Format: YYYY-MM. Last month to return billable usage logs for. This
field is required.`
cmd.Annotations = make(map[string]string)

10
cmd/account/budgets/budgets.go generated
View File

@ -124,7 +124,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete budget.`
cmd.Long = `Delete budget.
Deletes the budget specified by its UUID.`
Deletes the budget specified by its UUID.
Arguments:
BUDGET_ID: Budget ID`
cmd.Annotations = make(map[string]string)
@ -198,7 +201,10 @@ func newGet() *cobra.Command {
cmd.Long = `Get budget and its status.
Gets the budget specified by its UUID, including noncumulative status for each
day that the budget is configured to include.`
day that the budget is configured to include.
Arguments:
BUDGET_ID: Budget ID`
cmd.Annotations = make(map[string]string)

10
cmd/account/credentials/credentials.go generated
View File

@ -139,7 +139,10 @@ func newDelete() *cobra.Command {
Deletes a Databricks credential configuration object for an account, both
specified by ID. You cannot delete a credential that is associated with any
workspace.`
workspace.
Arguments:
CREDENTIALS_ID: Databricks Account API credential configuration ID`
cmd.Annotations = make(map[string]string)
@ -213,7 +216,10 @@ func newGet() *cobra.Command {
cmd.Long = `Get credential configuration.
Gets a Databricks credential configuration object for an account, both
specified by ID.`
specified by ID.
Arguments:
CREDENTIALS_ID: Databricks Account API credential configuration ID`
cmd.Annotations = make(map[string]string)

15
cmd/account/custom-app-integration/custom-app-integration.go generated
View File

@ -130,7 +130,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete Custom OAuth App Integration.
Delete an existing Custom OAuth App Integration. You can retrieve the custom
oauth app integration via :method:CustomAppIntegration/get.`
oauth app integration via :method:CustomAppIntegration/get.
Arguments:
INTEGRATION_ID: The oauth app integration ID.`
cmd.Annotations = make(map[string]string)
@ -191,7 +194,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get OAuth Custom App Integration.`
cmd.Long = `Get OAuth Custom App Integration.
Gets the Custom OAuth App Integration for the given integration id.`
Gets the Custom OAuth App Integration for the given integration id.
Arguments:
INTEGRATION_ID: The oauth app integration ID.`
cmd.Annotations = make(map[string]string)
@ -307,7 +313,10 @@ func newUpdate() *cobra.Command {
cmd.Long = `Updates Custom OAuth App Integration.
Updates an existing custom OAuth App Integration. You can retrieve the custom
oauth app integration via :method:CustomAppIntegration/get.`
oauth app integration via :method:CustomAppIntegration/get.
Arguments:
INTEGRATION_ID: The oauth app integration ID.`
cmd.Annotations = make(map[string]string)

10
cmd/account/encryption-keys/encryption-keys.go generated
View File

@ -155,7 +155,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete encryption key configuration.
Deletes a customer-managed key configuration object for an account. You cannot
delete a configuration that is associated with a running workspace.`
delete a configuration that is associated with a running workspace.
Arguments:
CUSTOMER_MANAGED_KEY_ID: Databricks encryption key configuration ID.`
cmd.Annotations = make(map[string]string)
@ -230,7 +233,10 @@ func newGet() *cobra.Command {
types, subscription types, and AWS regions.
This operation is available only if your account is on the E2 version of the
platform.",`
platform.",
Arguments:
CUSTOMER_MANAGED_KEY_ID: Databricks encryption key configuration ID.`
cmd.Annotations = make(map[string]string)

20
cmd/account/groups/groups.go generated
View File

@ -140,7 +140,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete a group.`
cmd.Long = `Delete a group.
Deletes a group from the Databricks account.`
Deletes a group from the Databricks account.
Arguments:
ID: Unique ID for a group in the Databricks account.`
cmd.Annotations = make(map[string]string)
@ -213,7 +216,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get group details.`
cmd.Long = `Get group details.
Gets the information for a specific group in the Databricks account.`
Gets the information for a specific group in the Databricks account.
Arguments:
ID: Unique ID for a group in the Databricks account.`
cmd.Annotations = make(map[string]string)
@ -358,7 +364,10 @@ func newPatch() *cobra.Command {
cmd.Short = `Update group details.`
cmd.Long = `Update group details.
Partially updates the details of a group.`
Partially updates the details of a group.
Arguments:
ID: Unique ID for a group in the Databricks account.`
cmd.Annotations = make(map[string]string)
@ -449,7 +458,10 @@ func newUpdate() *cobra.Command {
cmd.Short = `Replace a group.`
cmd.Long = `Replace a group.
Updates the details of a group by replacing the entire group entity.`
Updates the details of a group by replacing the entire group entity.
Arguments:
ID: Databricks group ID`
cmd.Annotations = make(map[string]string)

10
cmd/account/ip-access-lists/ip-access-lists.go generated
View File

@ -154,7 +154,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete access list.`
cmd.Long = `Delete access list.
Deletes an IP access list, specified by its list ID.`
Deletes an IP access list, specified by its list ID.
Arguments:
IP_ACCESS_LIST_ID: The ID for the corresponding IP access list.`
cmd.Annotations = make(map[string]string)
@ -227,7 +230,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get IP access list.`
cmd.Long = `Get IP access list.
Gets an IP access list, specified by its list ID.`
Gets an IP access list, specified by its list ID.
Arguments:
IP_ACCESS_LIST_ID: The ID for the corresponding IP access list.`
cmd.Annotations = make(map[string]string)

15
cmd/account/log-delivery/log-delivery.go generated
View File

@ -208,7 +208,10 @@ func newGet() *cobra.Command {
cmd.Long = `Get log delivery configuration.
Gets a Databricks log delivery configuration object for an account, both
specified by ID.`
specified by ID.
Arguments:
LOG_DELIVERY_CONFIGURATION_ID: Databricks log delivery configuration ID`
cmd.Annotations = make(map[string]string)
@ -351,7 +354,15 @@ func newPatchStatus() *cobra.Command {
configurations is not supported, so disable log delivery configurations that
are no longer needed. Note that you can't re-enable a delivery configuration
if this would violate the delivery configuration limits described under
[Create log delivery](:method:LogDelivery/Create).`
[Create log delivery](:method:LogDelivery/Create).
Arguments:
LOG_DELIVERY_CONFIGURATION_ID: Databricks log delivery configuration ID
STATUS: Status of log delivery configuration. Set to ENABLED (enabled) or
DISABLED (disabled). Defaults to ENABLED. You can [enable or disable
the configuration](#operation/patch-log-delivery-config-status) later.
Deletion of a configuration is not supported, so disable a log delivery
configuration that is no longer needed.`
cmd.Annotations = make(map[string]string)

28
cmd/account/metastore-assignments/metastore-assignments.go generated
View File

@ -59,7 +59,11 @@ func newCreate() *cobra.Command {
cmd.Short = `Assigns a workspace to a metastore.`
cmd.Long = `Assigns a workspace to a metastore.
Creates an assignment to a metastore for a workspace`
Creates an assignment to a metastore for a workspace
Arguments:
WORKSPACE_ID: Workspace ID.
METASTORE_ID: Unity Catalog metastore ID`
cmd.Annotations = make(map[string]string)
@ -131,7 +135,11 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete a metastore assignment.
Deletes a metastore assignment to a workspace, leaving the workspace with no
metastore.`
metastore.
Arguments:
WORKSPACE_ID: Workspace ID.
METASTORE_ID: Unity Catalog metastore ID`
cmd.Annotations = make(map[string]string)
@ -199,7 +207,10 @@ func newGet() *cobra.Command {
Gets the metastore assignment, if any, for the workspace specified by ID. If
the workspace is assigned a metastore, the mappig will be returned. If no
metastore is assigned to the workspace, the assignment will not be found and a
404 returned.`
404 returned.
Arguments:
WORKSPACE_ID: Workspace ID.`
cmd.Annotations = make(map[string]string)
@ -264,7 +275,10 @@ func newList() *cobra.Command {
cmd.Long = `Get all workspaces assigned to a metastore.
Gets a list of all Databricks workspace IDs that have been assigned to given
metastore.`
metastore.
Arguments:
METASTORE_ID: Unity Catalog metastore ID`
cmd.Annotations = make(map[string]string)
@ -330,7 +344,11 @@ func newUpdate() *cobra.Command {
cmd.Long = `Updates a metastore assignment to a workspaces.
Updates an assignment to a metastore for a workspace. Currently, only the
default catalog may be updated.`
default catalog may be updated.
Arguments:
WORKSPACE_ID: Workspace ID.
METASTORE_ID: Unity Catalog metastore ID`
cmd.Annotations = make(map[string]string)

15
cmd/account/metastores/metastores.go generated
View File

@ -126,7 +126,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete a metastore.`
cmd.Long = `Delete a metastore.
Deletes a Unity Catalog metastore for an account, both specified by ID.`
Deletes a Unity Catalog metastore for an account, both specified by ID.
Arguments:
METASTORE_ID: Unity Catalog metastore ID`
cmd.Annotations = make(map[string]string)
@ -187,7 +190,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get a metastore.`
cmd.Long = `Get a metastore.
Gets a Unity Catalog metastore from an account, both specified by ID.`
Gets a Unity Catalog metastore from an account, both specified by ID.
Arguments:
METASTORE_ID: Unity Catalog metastore ID`
cmd.Annotations = make(map[string]string)
@ -300,7 +306,10 @@ func newUpdate() *cobra.Command {
cmd.Short = `Update a metastore.`
cmd.Long = `Update a metastore.
Updates an existing Unity Catalog metastore.`
Updates an existing Unity Catalog metastore.
Arguments:
METASTORE_ID: Unity Catalog metastore ID`
cmd.Annotations = make(map[string]string)

47
cmd/account/network-connectivity/network-connectivity.go generated
View File

@ -77,7 +77,16 @@ func newCreateNetworkConnectivityConfiguration() *cobra.Command {
multiple workspaces from the same Azure region within the same Databricks
account. See [configure serverless secure connectivity].
[configure serverless secure connectivity]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security`
[configure serverless secure connectivity]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security
Arguments:
NAME: The name of the network connectivity configuration. The name can contain
alphanumeric characters, hyphens, and underscores. The length must be
between 3 and 30 characters. The name must match the regular expression
^[0-9a-zA-Z-_]{3,30}$.
REGION: The Azure region for this network connectivity configuration. Only
workspaces in the same Azure region can be attached to this network
connectivity configuration.`
cmd.Annotations = make(map[string]string)
@ -167,7 +176,14 @@ func newCreatePrivateEndpointRule() *cobra.Command {
private endpoint created, make a GET request on the new private endpoint
rule. See [serverless private link].
[serverless private link]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security/serverless-private-link`
[serverless private link]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security/serverless-private-link
Arguments:
NETWORK_CONNECTIVITY_CONFIG_ID: Your Network Connectvity Configuration ID.
RESOURCE_ID: The Azure resource ID of the target resource.
GROUP_ID: The sub-resource type (group ID) of the target resource. Note that to
connect to workspace root storage (root DBFS), you need two endpoints, one
for blob and one for dfs.`
cmd.Annotations = make(map[string]string)
@ -250,7 +266,10 @@ func newDeleteNetworkConnectivityConfiguration() *cobra.Command {
cmd.Short = `Delete a network connectivity configuration.`
cmd.Long = `Delete a network connectivity configuration.
Deletes a network connectivity configuration.`
Deletes a network connectivity configuration.
Arguments:
NETWORK_CONNECTIVITY_CONFIG_ID: Your Network Connectvity Configuration ID.`
cmd.Annotations = make(map[string]string)
@ -315,7 +334,11 @@ func newDeletePrivateEndpointRule() *cobra.Command {
deactivated and will be purged after seven days of deactivation. When a
private endpoint is in deactivated state, deactivated field is set to true
and the private endpoint is not available to your serverless compute
resources.`
resources.
Arguments:
NETWORK_CONNECTIVITY_CONFIG_ID: Your Network Connectvity Configuration ID.
PRIVATE_ENDPOINT_RULE_ID: Your private endpoint rule ID.`
cmd.Annotations = make(map[string]string)
@ -377,7 +400,10 @@ func newGetNetworkConnectivityConfiguration() *cobra.Command {
cmd.Short = `Get a network connectivity configuration.`
cmd.Long = `Get a network connectivity configuration.
Gets a network connectivity configuration.`
Gets a network connectivity configuration.
Arguments:
NETWORK_CONNECTIVITY_CONFIG_ID: Your Network Connectvity Configuration ID.`
cmd.Annotations = make(map[string]string)
@ -438,7 +464,11 @@ func newGetPrivateEndpointRule() *cobra.Command {
cmd.Short = `Get a private endpoint rule.`
cmd.Long = `Get a private endpoint rule.
Gets the private endpoint rule.`
Gets the private endpoint rule.
Arguments:
NETWORK_CONNECTIVITY_CONFIG_ID: Your Network Connectvity Configuration ID.
PRIVATE_ENDPOINT_RULE_ID: Your private endpoint rule ID.`
cmd.Annotations = make(map[string]string)
@ -563,7 +593,10 @@ func newListPrivateEndpointRules() *cobra.Command {
cmd.Short = `List private endpoint rules.`
cmd.Long = `List private endpoint rules.
Gets an array of private endpoint rules.`
Gets an array of private endpoint rules.
Arguments:
NETWORK_CONNECTIVITY_CONFIG_ID: Your Network Connectvity Configuration ID.`
cmd.Annotations = make(map[string]string)

22
cmd/account/network-policy/network-policy.go generated
View File

@ -63,7 +63,16 @@ func newDeleteAccountNetworkPolicy() *cobra.Command {
cmd.Short = `Delete Account Network Policy.`
cmd.Long = `Delete Account Network Policy.
Reverts back all the account network policies back to default.`
Reverts back all the account network policies back to default.
Arguments:
ETAG: etag used for versioning. The response is at least as fresh as the eTag
provided. This is used for optimistic concurrency control as a way to help
prevent simultaneous writes of a setting overwriting each other. It is
strongly suggested that systems make use of the etag in the read -> delete
pattern to perform setting deletions in order to avoid race conditions.
That is, get an etag from a GET request, and pass it with the DELETE
request to identify the rule set version you are deleting.`
cmd.Annotations = make(map[string]string)
@ -124,7 +133,16 @@ func newReadAccountNetworkPolicy() *cobra.Command {
cmd.Short = `Get Account Network Policy.`
cmd.Long = `Get Account Network Policy.
Gets the value of Account level Network Policy.`
Gets the value of Account level Network Policy.
Arguments:
ETAG: etag used for versioning. The response is at least as fresh as the eTag
provided. This is used for optimistic concurrency control as a way to help
prevent simultaneous writes of a setting overwriting each other. It is
strongly suggested that systems make use of the etag in the read -> delete
pattern to perform setting deletions in order to avoid race conditions.
That is, get an etag from a GET request, and pass it with the DELETE
request to identify the rule set version you are deleting.`
cmd.Annotations = make(map[string]string)

15
cmd/account/networks/networks.go generated
View File

@ -66,7 +66,10 @@ func newCreate() *cobra.Command {
Creates a Databricks network configuration that represents an VPC and its
resources. The VPC will be used for new Databricks clusters. This requires a
pre-existing VPC and subnets.`
pre-existing VPC and subnets.
Arguments:
NETWORK_NAME: The human-readable name of the network configuration.`
cmd.Annotations = make(map[string]string)
@ -147,7 +150,10 @@ func newDelete() *cobra.Command {
workspace.
This operation is available only if your account is on the E2 version of the
platform.`
platform.
Arguments:
NETWORK_ID: Databricks Account API network configuration ID.`
cmd.Annotations = make(map[string]string)
@ -221,7 +227,10 @@ func newGet() *cobra.Command {
cmd.Long = `Get a network configuration.
Gets a Databricks network configuration, which represents a cloud VPC and its
resources.`
resources.
Arguments:
NETWORK_ID: Databricks Account API network configuration ID.`
cmd.Annotations = make(map[string]string)

25
cmd/account/private-access/private-access.go generated
View File

@ -75,7 +75,12 @@ func newCreate() *cobra.Command {
PrivateLink].
[AWS PrivateLink]: https://aws.amazon.com/privatelink
[Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html`
[Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html
Arguments:
PRIVATE_ACCESS_SETTINGS_NAME: The human-readable name of the private access settings object.
REGION: The cloud region for workspaces associated with this private access
settings object.`
cmd.Annotations = make(map[string]string)
@ -161,7 +166,10 @@ func newDelete() *cobra.Command {
PrivateLink].
[AWS PrivateLink]: https://aws.amazon.com/privatelink
[Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html`
[Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html
Arguments:
PRIVATE_ACCESS_SETTINGS_ID: Databricks Account API private access settings ID.`
cmd.Annotations = make(map[string]string)
@ -241,7 +249,10 @@ func newGet() *cobra.Command {
PrivateLink].
[AWS PrivateLink]: https://aws.amazon.com/privatelink
[Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html`
[Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html
Arguments:
PRIVATE_ACCESS_SETTINGS_ID: Databricks Account API private access settings ID.`
cmd.Annotations = make(map[string]string)
@ -389,7 +400,13 @@ func newReplace() *cobra.Command {
PrivateLink].
[AWS PrivateLink]: https://aws.amazon.com/privatelink
[Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html`
[Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html
Arguments:
PRIVATE_ACCESS_SETTINGS_ID: Databricks Account API private access settings ID.
PRIVATE_ACCESS_SETTINGS_NAME: The human-readable name of the private access settings object.
REGION: The cloud region for workspaces associated with this private access
settings object.`
cmd.Annotations = make(map[string]string)

15
cmd/account/published-app-integration/published-app-integration.go generated
View File

@ -130,7 +130,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete Published OAuth App Integration.
Delete an existing Published OAuth App Integration. You can retrieve the
published oauth app integration via :method:PublishedAppIntegration/get.`
published oauth app integration via :method:PublishedAppIntegration/get.
Arguments:
INTEGRATION_ID: The oauth app integration ID.`
cmd.Annotations = make(map[string]string)
@ -191,7 +194,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get OAuth Published App Integration.`
cmd.Long = `Get OAuth Published App Integration.
Gets the Published OAuth App Integration for the given integration id.`
Gets the Published OAuth App Integration for the given integration id.
Arguments:
INTEGRATION_ID: The oauth app integration ID.`
cmd.Annotations = make(map[string]string)
@ -306,7 +312,10 @@ func newUpdate() *cobra.Command {
cmd.Long = `Updates Published OAuth App Integration.
Updates an existing published OAuth App Integration. You can retrieve the
published oauth app integration via :method:PublishedAppIntegration/get.`
published oauth app integration via :method:PublishedAppIntegration/get.
Arguments:
INTEGRATION_ID: The oauth app integration ID.`
cmd.Annotations = make(map[string]string)

16
cmd/account/service-principal-secrets/service-principal-secrets.go generated
View File

@ -66,7 +66,10 @@ func newCreate() *cobra.Command {
cmd.Short = `Create service principal secret.`
cmd.Long = `Create service principal secret.
Create a secret for the given service principal.`
Create a secret for the given service principal.
Arguments:
SERVICE_PRINCIPAL_ID: The service principal ID.`
cmd.Annotations = make(map[string]string)
@ -130,7 +133,11 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete service principal secret.`
cmd.Long = `Delete service principal secret.
Delete a secret from the given service principal.`
Delete a secret from the given service principal.
Arguments:
SERVICE_PRINCIPAL_ID: The service principal ID.
SECRET_ID: The secret ID.`
cmd.Annotations = make(map[string]string)
@ -197,7 +204,10 @@ func newList() *cobra.Command {
List all secrets associated with the given service principal. This operation
only returns information about the secrets themselves and does not include the
secret values.`
secret values.
Arguments:
SERVICE_PRINCIPAL_ID: The service principal ID.`
cmd.Annotations = make(map[string]string)

20
cmd/account/service-principals/service-principals.go generated
View File

@ -138,7 +138,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete a service principal.`
cmd.Long = `Delete a service principal.
Delete a single service principal in the Databricks account.`
Delete a single service principal in the Databricks account.
Arguments:
ID: Unique ID for a service principal in the Databricks account.`
cmd.Annotations = make(map[string]string)
@ -212,7 +215,10 @@ func newGet() *cobra.Command {
cmd.Long = `Get service principal details.
Gets the details for a single service principal define in the Databricks
account.`
account.
Arguments:
ID: Unique ID for a service principal in the Databricks account.`
cmd.Annotations = make(map[string]string)
@ -358,7 +364,10 @@ func newPatch() *cobra.Command {
cmd.Long = `Update service principal details.
Partially updates the details of a single service principal in the Databricks
account.`
account.
Arguments:
ID: Unique ID for a service principal in the Databricks account.`
cmd.Annotations = make(map[string]string)
@ -451,7 +460,10 @@ func newUpdate() *cobra.Command {
Updates the details of a single service principal.
This action replaces the existing service principal with the same name.`
This action replaces the existing service principal with the same name.
Arguments:
ID: Databricks service principal ID.`
cmd.Annotations = make(map[string]string)

22
cmd/account/settings/settings.go generated
View File

@ -64,7 +64,16 @@ func newDeletePersonalComputeSetting() *cobra.Command {
cmd.Short = `Delete Personal Compute setting.`
cmd.Long = `Delete Personal Compute setting.
Reverts back the Personal Compute setting value to default (ON)`
Reverts back the Personal Compute setting value to default (ON)
Arguments:
ETAG: etag used for versioning. The response is at least as fresh as the eTag
provided. This is used for optimistic concurrency control as a way to help
prevent simultaneous writes of a setting overwriting each other. It is
strongly suggested that systems make use of the etag in the read -> delete
pattern to perform setting deletions in order to avoid race conditions.
That is, get an etag from a GET request, and pass it with the DELETE
request to identify the rule set version you are deleting.`
cmd.Annotations = make(map[string]string)
@ -125,7 +134,16 @@ func newReadPersonalComputeSetting() *cobra.Command {
cmd.Short = `Get Personal Compute setting.`
cmd.Long = `Get Personal Compute setting.
Gets the value of the Personal Compute setting.`
Gets the value of the Personal Compute setting.
Arguments:
ETAG: etag used for versioning. The response is at least as fresh as the eTag
provided. This is used for optimistic concurrency control as a way to help
prevent simultaneous writes of a setting overwriting each other. It is
strongly suggested that systems make use of the etag in the read -> delete
pattern to perform setting deletions in order to avoid race conditions.
That is, get an etag from a GET request, and pass it with the DELETE
request to identify the rule set version you are deleting.`
cmd.Annotations = make(map[string]string)

28
cmd/account/storage-credentials/storage-credentials.go generated
View File

@ -63,7 +63,10 @@ func newCreate() *cobra.Command {
credentials * **GcpServiceAcountKey** for GCP credentials.
The caller must be a metastore admin and have the
**CREATE_STORAGE_CREDENTIAL** privilege on the metastore.`
**CREATE_STORAGE_CREDENTIAL** privilege on the metastore.
Arguments:
METASTORE_ID: Unity Catalog metastore ID`
cmd.Annotations = make(map[string]string)
@ -133,7 +136,11 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete a storage credential.
Deletes a storage credential from the metastore. The caller must be an owner
of the storage credential.`
of the storage credential.
Arguments:
METASTORE_ID: Unity Catalog metastore ID
STORAGE_CREDENTIAL_NAME: Name of the storage credential.`
cmd.Annotations = make(map[string]string)
@ -197,7 +204,11 @@ func newGet() *cobra.Command {
Gets a storage credential from the metastore. The caller must be a metastore
admin, the owner of the storage credential, or have a level of privilege on
the storage credential.`
the storage credential.
Arguments:
METASTORE_ID: Unity Catalog metastore ID
STORAGE_CREDENTIAL_NAME: Name of the storage credential.`
cmd.Annotations = make(map[string]string)
@ -260,7 +271,10 @@ func newList() *cobra.Command {
cmd.Long = `Get all storage credentials assigned to a metastore.
Gets a list of all storage credentials that have been assigned to given
metastore.`
metastore.
Arguments:
METASTORE_ID: Unity Catalog metastore ID`
cmd.Annotations = make(map[string]string)
@ -327,7 +341,11 @@ func newUpdate() *cobra.Command {
Updates a storage credential on the metastore. The caller must be the owner of
the storage credential. If the caller is a metastore admin, only the __owner__
credential can be changed.`
credential can be changed.
Arguments:
METASTORE_ID: Unity Catalog metastore ID
STORAGE_CREDENTIAL_NAME: Name of the storage credential.`
cmd.Annotations = make(map[string]string)

10
cmd/account/storage/storage.go generated
View File

@ -135,7 +135,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete storage configuration.
Deletes a Databricks storage configuration. You cannot delete a storage
configuration that is associated with any workspace.`
configuration that is associated with any workspace.
Arguments:
STORAGE_CONFIGURATION_ID: Databricks Account API storage configuration ID.`
cmd.Annotations = make(map[string]string)
@ -208,7 +211,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get storage configuration.`
cmd.Long = `Get storage configuration.
Gets a Databricks storage configuration for an account, both specified by ID.`
Gets a Databricks storage configuration for an account, both specified by ID.
Arguments:
STORAGE_CONFIGURATION_ID: Databricks Account API storage configuration ID.`
cmd.Annotations = make(map[string]string)

21
cmd/account/users/users.go generated
View File

@ -147,7 +147,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete a user.
Deletes a user. Deleting a user from a Databricks account also removes objects
associated with the user.`
associated with the user.
Arguments:
ID: Unique ID for a user in the Databricks account.`
cmd.Annotations = make(map[string]string)
@ -228,7 +231,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get user details.`
cmd.Long = `Get user details.
Gets information for a specific user in Databricks account.`
Gets information for a specific user in Databricks account.
Arguments:
ID: Unique ID for a user in the Databricks account.`
cmd.Annotations = make(map[string]string)
@ -374,7 +380,10 @@ func newPatch() *cobra.Command {
cmd.Long = `Update user details.
Partially updates a user resource by applying the supplied operations on
specific user attributes.`
specific user attributes.
Arguments:
ID: Unique ID for a user in the Databricks account.`
cmd.Annotations = make(map[string]string)
@ -467,7 +476,11 @@ func newUpdate() *cobra.Command {
cmd.Short = `Replace a user.`
cmd.Long = `Replace a user.
Replaces a user's information with the data supplied in request.`
Replaces a user's information with the data supplied in request.
Arguments:
ID: Databricks user ID. This is automatically set by Databricks. Any value
provided by the client will be ignored.`
cmd.Annotations = make(map[string]string)

15
cmd/account/vpc-endpoints/vpc-endpoints.go generated
View File

@ -73,7 +73,10 @@ func newCreate() *cobra.Command {
[AWS PrivateLink]: https://aws.amazon.com/privatelink
[Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html
[VPC endpoint]: https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints.html
[endpoint service]: https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html`
[endpoint service]: https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html
Arguments:
VPC_ENDPOINT_NAME: The human-readable name of the storage configuration.`
cmd.Annotations = make(map[string]string)
@ -157,7 +160,10 @@ func newDelete() *cobra.Command {
[AWS PrivateLink]: https://aws.amazon.com/privatelink
[AWS VPC endpoint]: https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html
[Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html`
[Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html
Arguments:
VPC_ENDPOINT_ID: Databricks VPC endpoint ID.`
cmd.Annotations = make(map[string]string)
@ -234,7 +240,10 @@ func newGet() *cobra.Command {
AWS used to communicate privately with Databricks over [AWS PrivateLink].
[AWS PrivateLink]: https://aws.amazon.com/privatelink
[VPC endpoint]: https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html`
[VPC endpoint]: https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html
Arguments:
VPC_ENDPOINT_ID: Databricks VPC endpoint ID.`
cmd.Annotations = make(map[string]string)

16
cmd/account/workspace-assignment/workspace-assignment.go generated
View File

@ -57,7 +57,11 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete permissions assignment.
Deletes the workspace permissions assignment in a given account and workspace
for the specified principal.`
for the specified principal.
Arguments:
WORKSPACE_ID: The workspace ID.
PRINCIPAL_ID: The ID of the user, service principal, or group.`
cmd.Annotations = make(map[string]string)
@ -125,7 +129,10 @@ func newGet() *cobra.Command {
cmd.Short = `List workspace permissions.`
cmd.Long = `List workspace permissions.
Get an array of workspace permissions for the specified account and workspace.`
Get an array of workspace permissions for the specified account and workspace.
Arguments:
WORKSPACE_ID: The workspace ID.`
cmd.Annotations = make(map[string]string)
@ -190,7 +197,10 @@ func newList() *cobra.Command {
cmd.Long = `Get permission assignments.
Get the permission assignments for the specified Databricks account and
Databricks workspace.`
Databricks workspace.
Arguments:
WORKSPACE_ID: The workspace ID for the account.`
cmd.Annotations = make(map[string]string)

20
cmd/account/workspaces/workspaces.go generated
View File

@ -94,7 +94,10 @@ func newCreate() *cobra.Command {
workspace status is typically PROVISIONING. Use the workspace ID
(workspace_id) field in the response to identify the new workspace and make
repeated GET requests with the workspace ID and check its status. The
workspace becomes available when the status changes to RUNNING.`
workspace becomes available when the status changes to RUNNING.
Arguments:
WORKSPACE_NAME: The workspace's human-readable name.`
cmd.Annotations = make(map[string]string)
@ -189,7 +192,10 @@ func newDelete() *cobra.Command {
This operation is available only if your account is on the E2 version of the
platform or on a select custom plan that allows multiple workspaces per
account.`
account.
Arguments:
WORKSPACE_ID: Workspace ID.`
cmd.Annotations = make(map[string]string)
@ -278,7 +284,10 @@ func newGet() *cobra.Command {
platform or on a select custom plan that allows multiple workspaces per
account.
[Create a new workspace using the Account API]: http://docs.databricks.com/administration-guide/account-api/new-workspace.html`
[Create a new workspace using the Account API]: http://docs.databricks.com/administration-guide/account-api/new-workspace.html
Arguments:
WORKSPACE_ID: Workspace ID.`
cmd.Annotations = make(map[string]string)
@ -534,7 +543,10 @@ func newUpdate() *cobra.Command {
account.
[Account Console]: https://docs.databricks.com/administration-guide/account-settings-e2/account-console-e2.html
[Create a new workspace using the Account API]: http://docs.databricks.com/administration-guide/account-api/new-workspace.html`
[Create a new workspace using the Account API]: http://docs.databricks.com/administration-guide/account-api/new-workspace.html
Arguments:
WORKSPACE_ID: Workspace ID.`
cmd.Annotations = make(map[string]string)

20
cmd/workspace/apps/apps.go generated
View File

@ -127,7 +127,10 @@ func newDeleteApp() *cobra.Command {
cmd.Short = `Delete an application.`
cmd.Long = `Delete an application.
Delete an application definition`
Delete an application definition
Arguments:
NAME: The name of an application. This field is required.`
cmd.Annotations = make(map[string]string)
@ -188,7 +191,10 @@ func newGetApp() *cobra.Command {
cmd.Short = `Get definition for an application.`
cmd.Long = `Get definition for an application.
Get an application definition`
Get an application definition
Arguments:
NAME: The name of an application. This field is required.`
cmd.Annotations = make(map[string]string)
@ -251,7 +257,10 @@ func newGetAppDeploymentStatus() *cobra.Command {
cmd.Short = `Get deployment status for an application.`
cmd.Long = `Get deployment status for an application.
Get deployment status for an application`
Get deployment status for an application
Arguments:
DEPLOYMENT_ID: The deployment id for an application. This field is required.`
cmd.Annotations = make(map[string]string)
@ -360,7 +369,10 @@ func newGetEvents() *cobra.Command {
cmd.Short = `Get deployment events for an application.`
cmd.Long = `Get deployment events for an application.
Get deployment events for an application`
Get deployment events for an application
Arguments:
NAME: The name of an application. This field is required.`
cmd.Annotations = make(map[string]string)

5
cmd/workspace/artifact-allowlists/artifact-allowlists.go generated
View File

@ -58,7 +58,10 @@ func newGet() *cobra.Command {
cmd.Long = `Get an artifact allowlist.
Get the artifact allowlist of a certain artifact type. The caller must be a
metastore admin or have the **MANAGE ALLOWLIST** privilege on the metastore.`
metastore admin or have the **MANAGE ALLOWLIST** privilege on the metastore.
Arguments:
ARTIFACT_TYPE: The artifact type of the allowlist.`
cmd.Annotations = make(map[string]string)

20
cmd/workspace/catalogs/catalogs.go generated
View File

@ -73,7 +73,10 @@ func newCreate() *cobra.Command {
cmd.Long = `Create a catalog.
Creates a new catalog instance in the parent metastore if the caller is a
metastore admin or has the **CREATE_CATALOG** privilege.`
metastore admin or has the **CREATE_CATALOG** privilege.
Arguments:
NAME: Name of catalog.`
cmd.Annotations = make(map[string]string)
@ -152,7 +155,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete a catalog.
Deletes the catalog that matches the supplied name. The caller must be a
metastore admin or the owner of the catalog.`
metastore admin or the owner of the catalog.
Arguments:
NAME: The name of the catalog.`
cmd.Annotations = make(map[string]string)
@ -215,7 +221,10 @@ func newGet() *cobra.Command {
Gets the specified catalog in a metastore. The caller must be a metastore
admin, the owner of the catalog, or a user that has the **USE_CATALOG**
privilege set for their account.`
privilege set for their account.
Arguments:
NAME: The name of the catalog.`
cmd.Annotations = make(map[string]string)
@ -339,7 +348,10 @@ func newUpdate() *cobra.Command {
Updates the catalog that matches the supplied name. The caller must be either
the owner of the catalog, or a metastore admin (when changing the owner field
of the catalog).`
of the catalog).
Arguments:
NAME: Name of catalog.`
cmd.Annotations = make(map[string]string)

15
cmd/workspace/clean-rooms/clean-rooms.go generated
View File

@ -132,7 +132,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete a clean room.
Deletes a data object clean room from the metastore. The caller must be an
owner of the clean room.`
owner of the clean room.
Arguments:
NAME_ARG: The name of the clean room.`
cmd.Annotations = make(map[string]string)
@ -196,7 +199,10 @@ func newGet() *cobra.Command {
cmd.Long = `Get a clean room.
Gets a data object clean room from the metastore. The caller must be a
metastore admin or the owner of the clean room.`
metastore admin or the owner of the clean room.
Arguments:
NAME_ARG: The name of the clean room.`
cmd.Annotations = make(map[string]string)
@ -341,7 +347,10 @@ func newUpdate() *cobra.Command {
indefinitely for recipients to be able to access the table. Typically, you
should use a group as the clean room owner.
Table removals through **update** do not require additional privileges.`
Table removals through **update** do not require additional privileges.
Arguments:
NAME_ARG: The name of the clean room.`
cmd.Annotations = make(map[string]string)

43
cmd/workspace/cluster-policies/cluster-policies.go generated
View File

@ -85,7 +85,11 @@ func newCreate() *cobra.Command {
cmd.Short = `Create a new policy.`
cmd.Long = `Create a new policy.
Creates a new policy with prescribed settings.`
Creates a new policy with prescribed settings.
Arguments:
NAME: Cluster Policy name requested by the user. This has to be unique. Length
must be between 1 and 100 characters.`
cmd.Annotations = make(map[string]string)
@ -164,7 +168,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete a cluster policy.
Delete a policy for a cluster. Clusters governed by this policy can still run,
but cannot be edited.`
but cannot be edited.
Arguments:
POLICY_ID: The ID of the policy to delete.`
cmd.Annotations = make(map[string]string)
@ -254,7 +261,12 @@ func newEdit() *cobra.Command {
cmd.Long = `Update a cluster policy.
Update an existing policy for cluster. This operation may make some clusters
governed by the previous policy invalid.`
governed by the previous policy invalid.
Arguments:
POLICY_ID: The ID of the policy to update.
NAME: Cluster Policy name requested by the user. This has to be unique. Length
must be between 1 and 100 characters.`
cmd.Annotations = make(map[string]string)
@ -333,7 +345,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get a cluster policy.`
cmd.Long = `Get a cluster policy.
Get a cluster policy entity. Creation and editing is available to admins only.`
Get a cluster policy entity. Creation and editing is available to admins only.
Arguments:
POLICY_ID: Canonical unique identifier for the cluster policy.`
cmd.Annotations = make(map[string]string)
@ -406,7 +421,10 @@ func newGetPermissionLevels() *cobra.Command {
cmd.Short = `Get cluster policy permission levels.`
cmd.Long = `Get cluster policy permission levels.
Gets the permission levels that a user can have on an object.`
Gets the permission levels that a user can have on an object.
Arguments:
CLUSTER_POLICY_ID: The cluster policy for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -480,7 +498,10 @@ func newGetPermissions() *cobra.Command {
cmd.Long = `Get cluster policy permissions.
Gets the permissions of a cluster policy. Cluster policies can inherit
permissions from their root object.`
permissions from their root object.
Arguments:
CLUSTER_POLICY_ID: The cluster policy for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -620,7 +641,10 @@ func newSetPermissions() *cobra.Command {
cmd.Long = `Set cluster policy permissions.
Sets permissions on a cluster policy. Cluster policies can inherit permissions
from their root object.`
from their root object.
Arguments:
CLUSTER_POLICY_ID: The cluster policy for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -704,7 +728,10 @@ func newUpdatePermissions() *cobra.Command {
cmd.Long = `Update cluster policy permissions.
Updates the permissions on a cluster policy. Cluster policies can inherit
permissions from their root object.`
permissions from their root object.
Arguments:
CLUSTER_POLICY_ID: The cluster policy for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)

86
cmd/workspace/clusters/clusters.go generated
View File

@ -85,7 +85,11 @@ func newChangeOwner() *cobra.Command {
cmd.Long = `Change cluster owner.
Change the owner of the cluster. You must be an admin to perform this
operation.`
operation.
Arguments:
CLUSTER_ID: <needs content added>
OWNER_USERNAME: New owner of the cluster_id after this RPC.`
cmd.Annotations = make(map[string]string)
@ -206,7 +210,12 @@ func newCreate() *cobra.Command {
If Databricks acquires at least 85% of the requested on-demand nodes, cluster
creation will succeed. Otherwise the cluster will terminate with an
informative error message.`
informative error message.
Arguments:
SPARK_VERSION: The Spark version of the cluster, e.g. 3.3.x-scala2.11. A list of
available Spark versions can be retrieved by using the
:method:clusters/sparkVersions API call.`
cmd.Annotations = make(map[string]string)
@ -304,7 +313,10 @@ func newDelete() *cobra.Command {
Terminates the Spark cluster with the specified ID. The cluster is removed
asynchronously. Once the termination has completed, the cluster will be in a
TERMINATED state. If the cluster is already in a TERMINATING or
TERMINATED state, nothing will happen.`
TERMINATED state, nothing will happen.
Arguments:
CLUSTER_ID: The cluster to be terminated.`
cmd.Annotations = make(map[string]string)
@ -442,7 +454,13 @@ func newEdit() *cobra.Command {
new attributes will take effect. Any attempt to update a cluster in any other
state will be rejected with an INVALID_STATE error code.
Clusters created by the Databricks Jobs service cannot be edited.`
Clusters created by the Databricks Jobs service cannot be edited.
Arguments:
CLUSTER_ID: ID of the cluser
SPARK_VERSION: The Spark version of the cluster, e.g. 3.3.x-scala2.11. A list of
available Spark versions can be retrieved by using the
:method:clusters/sparkVersions API call.`
cmd.Annotations = make(map[string]string)
@ -544,7 +562,10 @@ func newEvents() *cobra.Command {
Retrieves a list of events about the activity of a cluster. This API is
paginated. If there are more events to read, the response includes all the
nparameters necessary to request the next page of events.`
nparameters necessary to request the next page of events.
Arguments:
CLUSTER_ID: The ID of the cluster to retrieve events about.`
cmd.Annotations = make(map[string]string)
@ -630,7 +651,10 @@ func newGet() *cobra.Command {
cmd.Long = `Get cluster info.
Retrieves the information for a cluster given its identifier. Clusters can be
described while they are running, or up to 60 days after they are terminated.`
described while they are running, or up to 60 days after they are terminated.
Arguments:
CLUSTER_ID: The cluster about which to retrieve information.`
cmd.Annotations = make(map[string]string)
@ -703,7 +727,10 @@ func newGetPermissionLevels() *cobra.Command {
cmd.Short = `Get cluster permission levels.`
cmd.Long = `Get cluster permission levels.
Gets the permission levels that a user can have on an object.`
Gets the permission levels that a user can have on an object.
Arguments:
CLUSTER_ID: The cluster for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -777,7 +804,10 @@ func newGetPermissions() *cobra.Command {
cmd.Long = `Get cluster permissions.
Gets the permissions of a cluster. Clusters can inherit permissions from their
root object.`
root object.
Arguments:
CLUSTER_ID: The cluster for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -1024,7 +1054,10 @@ func newPermanentDelete() *cobra.Command {
In addition, users will no longer see permanently deleted clusters in the
cluster list, and API users can no longer perform any action on permanently
deleted clusters.`
deleted clusters.
Arguments:
CLUSTER_ID: The cluster to be deleted.`
cmd.Annotations = make(map[string]string)
@ -1108,7 +1141,10 @@ func newPin() *cobra.Command {
Pinning a cluster ensures that the cluster will always be returned by the
ListClusters API. Pinning a cluster that is already pinned will have no
effect. This API can only be called by workspace admins.`
effect. This API can only be called by workspace admins.
Arguments:
CLUSTER_ID: <needs content added>`
cmd.Annotations = make(map[string]string)
@ -1199,7 +1235,10 @@ func newResize() *cobra.Command {
cmd.Long = `Resize cluster.
Resizes a cluster to have a desired number of workers. This will fail unless
the cluster is in a RUNNING state.`
the cluster is in a RUNNING state.
Arguments:
CLUSTER_ID: The cluster to be resized.`
cmd.Annotations = make(map[string]string)
@ -1301,7 +1340,10 @@ func newRestart() *cobra.Command {
cmd.Long = `Restart cluster.
Restarts a Spark cluster with the supplied ID. If the cluster is not currently
in a RUNNING state, nothing will happen.`
in a RUNNING state, nothing will happen.
Arguments:
CLUSTER_ID: The cluster to be started.`
cmd.Annotations = make(map[string]string)
@ -1398,7 +1440,10 @@ func newSetPermissions() *cobra.Command {
cmd.Long = `Set cluster permissions.
Sets permissions on a cluster. Clusters can inherit permissions from their
root object.`
root object.
Arguments:
CLUSTER_ID: The cluster for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -1540,7 +1585,10 @@ func newStart() *cobra.Command {
with the last specified cluster size. * If the previous cluster was an
autoscaling cluster, the current cluster starts with the minimum number of
nodes. * If the cluster is not currently in a TERMINATED state, nothing will
happen. * Clusters launched to run a job cannot be started.`
happen. * Clusters launched to run a job cannot be started.
Arguments:
CLUSTER_ID: The cluster to be started.`
cmd.Annotations = make(map[string]string)
@ -1636,7 +1684,10 @@ func newUnpin() *cobra.Command {
Unpinning a cluster will allow the cluster to eventually be removed from the
ListClusters API. Unpinning a cluster that is not pinned will have no effect.
This API can only be called by workspace admins.`
This API can only be called by workspace admins.
Arguments:
CLUSTER_ID: <needs content added>`
cmd.Annotations = make(map[string]string)
@ -1721,7 +1772,10 @@ func newUpdatePermissions() *cobra.Command {
cmd.Long = `Update cluster permissions.
Updates the permissions on a cluster. Clusters can inherit permissions from
their root object.`
their root object.
Arguments:
CLUSTER_ID: The cluster for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)

10
cmd/workspace/connections/connections.go generated
View File

@ -138,7 +138,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete a connection.`
cmd.Long = `Delete a connection.
Deletes the connection that matches the supplied name.`
Deletes the connection that matches the supplied name.
Arguments:
NAME_ARG: The name of the connection to be deleted.`
cmd.Annotations = make(map[string]string)
@ -211,7 +214,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get a connection.`
cmd.Long = `Get a connection.
Gets a connection from it's name.`
Gets a connection from it's name.
Arguments:
NAME_ARG: Name of the connection.`
cmd.Annotations = make(map[string]string)

124
cmd/workspace/experiments/experiments.go generated
View File

@ -73,7 +73,10 @@ func newCreateExperiment() *cobra.Command {
already exist and fails if another experiment with the same name already
exists.
Throws RESOURCE_ALREADY_EXISTS if a experiment with the given name exists.`
Throws RESOURCE_ALREADY_EXISTS if a experiment with the given name exists.
Arguments:
NAME: Experiment name.`
cmd.Annotations = make(map[string]string)
@ -229,7 +232,10 @@ func newDeleteExperiment() *cobra.Command {
Marks an experiment and associated metadata, runs, metrics, params, and tags
for deletion. If the experiment uses FileStore, artifacts associated with
experiment are also deleted.`
experiment are also deleted.
Arguments:
EXPERIMENT_ID: ID of the associated experiment.`
cmd.Annotations = make(map[string]string)
@ -307,7 +313,10 @@ func newDeleteRun() *cobra.Command {
cmd.Short = `Delete a run.`
cmd.Long = `Delete a run.
Marks a run for deletion.`
Marks a run for deletion.
Arguments:
RUN_ID: ID of the run to delete.`
cmd.Annotations = make(map[string]string)
@ -388,7 +397,13 @@ func newDeleteRuns() *cobra.Command {
cmd.Long = `Delete runs by creation time.
Bulk delete runs in an experiment that were created prior to or at the
specified timestamp. Deletes at most max_runs per request.`
specified timestamp. Deletes at most max_runs per request.
Arguments:
EXPERIMENT_ID: The ID of the experiment containing the runs to delete.
MAX_TIMESTAMP_MILLIS: The maximum creation timestamp in milliseconds since the UNIX epoch for
deleting runs. Only runs created prior to or at this timestamp are
deleted.`
cmd.Annotations = make(map[string]string)
@ -473,7 +488,11 @@ func newDeleteTag() *cobra.Command {
cmd.Long = `Delete a tag.
Deletes a tag on a run. Tags are run metadata that can be updated during a run
and after a run completes.`
and after a run completes.
Arguments:
RUN_ID: ID of the run that the tag was logged under. Must be provided.
KEY: Name of the tag. Maximum size is 255 bytes. Must be provided.`
cmd.Annotations = make(map[string]string)
@ -560,7 +579,10 @@ func newGetByName() *cobra.Command {
them.
Throws RESOURCE_DOES_NOT_EXIST if no experiment with the specified name
exists.`
exists.
Arguments:
EXPERIMENT_NAME: Name of the associated experiment.`
cmd.Annotations = make(map[string]string)
@ -621,7 +643,10 @@ func newGetExperiment() *cobra.Command {
cmd.Short = `Get an experiment.`
cmd.Long = `Get an experiment.
Gets metadata for an experiment. This method works on deleted experiments.`
Gets metadata for an experiment. This method works on deleted experiments.
Arguments:
EXPERIMENT_ID: ID of the associated experiment.`
cmd.Annotations = make(map[string]string)
@ -687,7 +712,10 @@ func newGetHistory() *cobra.Command {
cmd.Short = `Get history of a given metric within a run.`
cmd.Long = `Get history of a given metric within a run.
Gets a list of all values for the specified metric for a given run.`
Gets a list of all values for the specified metric for a given run.
Arguments:
METRIC_KEY: Name of the metric.`
cmd.Annotations = make(map[string]string)
@ -748,7 +776,10 @@ func newGetPermissionLevels() *cobra.Command {
cmd.Short = `Get experiment permission levels.`
cmd.Long = `Get experiment permission levels.
Gets the permission levels that a user can have on an object.`
Gets the permission levels that a user can have on an object.
Arguments:
EXPERIMENT_ID: The experiment for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -810,7 +841,10 @@ func newGetPermissions() *cobra.Command {
cmd.Long = `Get experiment permissions.
Gets the permissions of an experiment. Experiments can inherit permissions
from their root object.`
from their root object.
Arguments:
EXPERIMENT_ID: The experiment for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -878,7 +912,10 @@ func newGetRun() *cobra.Command {
with the latest timestamp.
If there are multiple values with the latest timestamp, return the maximum of
these values.`
these values.
Arguments:
RUN_ID: ID of the run to fetch. Must be provided.`
cmd.Annotations = make(map[string]string)
@ -1256,7 +1293,12 @@ func newLogMetric() *cobra.Command {
Logs a metric for a run. A metric is a key-value pair (string key, float
value) with an associated timestamp. Examples include the various metrics that
represent ML model accuracy. A metric can be logged multiple times.`
represent ML model accuracy. A metric can be logged multiple times.
Arguments:
KEY: Name of the metric.
VALUE: Double value of the metric being logged.
TIMESTAMP: Unix timestamp in milliseconds at the time metric was logged.`
cmd.Annotations = make(map[string]string)
@ -1424,7 +1466,11 @@ func newLogParam() *cobra.Command {
Logs a param used for a run. A param is a key-value pair (string key, string
value). Examples include hyperparameters used for ML model training and
constant dates and values used in an ETL pipeline. A param can be logged only
once for a run.`
once for a run.
Arguments:
KEY: Name of the param. Maximum size is 255 bytes.
VALUE: String value of the param being logged. Maximum size is 500 bytes.`
cmd.Annotations = make(map[string]string)
@ -1510,7 +1556,10 @@ func newRestoreExperiment() *cobra.Command {
underlying artifacts associated with experiment are also restored.
Throws RESOURCE_DOES_NOT_EXIST if experiment was never created or was
permanently deleted.`
permanently deleted.
Arguments:
EXPERIMENT_ID: ID of the associated experiment.`
cmd.Annotations = make(map[string]string)
@ -1588,7 +1637,10 @@ func newRestoreRun() *cobra.Command {
cmd.Short = `Restore a run.`
cmd.Long = `Restore a run.
Restores a deleted run.`
Restores a deleted run.
Arguments:
RUN_ID: ID of the run to restore.`
cmd.Annotations = make(map[string]string)
@ -1669,7 +1721,13 @@ func newRestoreRuns() *cobra.Command {
cmd.Long = `Restore runs by deletion time.
Bulk restore runs in an experiment that were deleted no earlier than the
specified timestamp. Restores at most max_runs per request.`
specified timestamp. Restores at most max_runs per request.
Arguments:
EXPERIMENT_ID: The ID of the experiment containing the runs to restore.
MIN_TIMESTAMP_MILLIS: The minimum deletion timestamp in milliseconds since the UNIX epoch for
restoring runs. Only runs deleted no earlier than this timestamp are
restored.`
cmd.Annotations = make(map[string]string)
@ -1904,7 +1962,15 @@ func newSetExperimentTag() *cobra.Command {
cmd.Short = `Set a tag.`
cmd.Long = `Set a tag.
Sets a tag on an experiment. Experiment tags are metadata that can be updated.`
Sets a tag on an experiment. Experiment tags are metadata that can be updated.
Arguments:
EXPERIMENT_ID: ID of the experiment under which to log the tag. Must be provided.
KEY: Name of the tag. Maximum size depends on storage backend. All storage
backends are guaranteed to support key values up to 250 bytes in size.
VALUE: String value of the tag being logged. Maximum size depends on storage
backend. All storage backends are guaranteed to support key values up to
5000 bytes in size.`
cmd.Annotations = make(map[string]string)
@ -1991,7 +2057,10 @@ func newSetPermissions() *cobra.Command {
cmd.Long = `Set experiment permissions.
Sets permissions on an experiment. Experiments can inherit permissions from
their root object.`
their root object.
Arguments:
EXPERIMENT_ID: The experiment for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -2064,7 +2133,14 @@ func newSetTag() *cobra.Command {
cmd.Long = `Set a tag.
Sets a tag on a run. Tags are run metadata that can be updated during a run
and after a run completes.`
and after a run completes.
Arguments:
KEY: Name of the tag. Maximum size depends on storage backend. All storage
backends are guaranteed to support key values up to 250 bytes in size.
VALUE: String value of the tag being logged. Maximum size depends on storage
backend. All storage backends are guaranteed to support key values up to
5000 bytes in size.`
cmd.Annotations = make(map[string]string)
@ -2147,7 +2223,10 @@ func newUpdateExperiment() *cobra.Command {
cmd.Short = `Update an experiment.`
cmd.Long = `Update an experiment.
Updates experiment metadata.`
Updates experiment metadata.
Arguments:
EXPERIMENT_ID: ID of the associated experiment.`
cmd.Annotations = make(map[string]string)
@ -2228,7 +2307,10 @@ func newUpdatePermissions() *cobra.Command {
cmd.Long = `Update experiment permissions.
Updates the permissions on an experiment. Experiments can inherit permissions
from their root object.`
from their root object.
Arguments:
EXPERIMENT_ID: The experiment for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)

22
cmd/workspace/external-locations/external-locations.go generated
View File

@ -77,7 +77,12 @@ func newCreate() *cobra.Command {
Creates a new external location entry in the metastore. The caller must be a
metastore admin or have the **CREATE_EXTERNAL_LOCATION** privilege on both the
metastore and the associated storage credential.`
metastore and the associated storage credential.
Arguments:
NAME: Name of the external location.
URL: Path URL of the external location.
CREDENTIAL_NAME: Name of the storage credential used with this location.`
cmd.Annotations = make(map[string]string)
@ -162,7 +167,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete an external location.
Deletes the specified external location from the metastore. The caller must be
the owner of the external location.`
the owner of the external location.
Arguments:
NAME: Name of the external location.`
cmd.Annotations = make(map[string]string)
@ -225,7 +233,10 @@ func newGet() *cobra.Command {
Gets an external location from the metastore. The caller must be either a
metastore admin, the owner of the external location, or a user that has some
privilege on the external location.`
privilege on the external location.
Arguments:
NAME: Name of the external location.`
cmd.Annotations = make(map[string]string)
@ -352,7 +363,10 @@ func newUpdate() *cobra.Command {
Updates an external location in the metastore. The caller must be the owner of
the external location, or be a metastore admin. In the second case, the admin
can only update the name of the external location.`
can only update the name of the external location.
Arguments:
NAME: Name of the external location.`
cmd.Annotations = make(map[string]string)

24
cmd/workspace/functions/functions.go generated
View File

@ -136,7 +136,11 @@ func newDelete() *cobra.Command {
of the function's parent catalog - Is the owner of the function's parent
schema and have the **USE_CATALOG** privilege on its parent catalog - Is the
owner of the function itself and have both the **USE_CATALOG** privilege on
its parent catalog and the **USE_SCHEMA** privilege on its parent schema`
its parent catalog and the **USE_SCHEMA** privilege on its parent schema
Arguments:
NAME: The fully-qualified name of the function (of the form
__catalog_name__.__schema_name__.__function__name__).`
cmd.Annotations = make(map[string]string)
@ -215,7 +219,11 @@ func newGet() *cobra.Command {
**USE_CATALOG** privilege on the function's parent catalog and be the owner of
the function - Have the **USE_CATALOG** privilege on the function's parent
catalog, the **USE_SCHEMA** privilege on the function's parent schema, and the
**EXECUTE** privilege on the function itself`
**EXECUTE** privilege on the function itself
Arguments:
NAME: The fully-qualified name of the function (of the form
__catalog_name__.__schema_name__.__function__name__).`
cmd.Annotations = make(map[string]string)
@ -294,7 +302,11 @@ func newList() *cobra.Command {
**USE_SCHEMA** privilege on the schema, and the output list contains only
functions for which either the user has the **EXECUTE** privilege or the user
is the owner. There is no guarantee of a specific ordering of the elements in
the array.`
the array.
Arguments:
CATALOG_NAME: Name of parent catalog for functions of interest.
SCHEMA_NAME: Parent schema of functions.`
cmd.Annotations = make(map[string]string)
@ -367,7 +379,11 @@ func newUpdate() *cobra.Command {
function's parent schema and has the **USE_CATALOG** privilege on its parent
catalog - Is the owner of the function itself and has the **USE_CATALOG**
privilege on its parent catalog as well as the **USE_SCHEMA** privilege on the
function's parent schema.`
function's parent schema.
Arguments:
NAME: The fully-qualified name of the function (of the form
__catalog_name__.__schema_name__.__function__name__).`
cmd.Annotations = make(map[string]string)

22
cmd/workspace/git-credentials/git-credentials.go generated
View File

@ -68,7 +68,12 @@ func newCreate() *cobra.Command {
Creates a Git credential entry for the user. Only one Git credential per user
is supported, so any attempts to create credentials if an entry already exists
will fail. Use the PATCH endpoint to update existing credentials, or the
DELETE endpoint to delete existing credentials.`
DELETE endpoint to delete existing credentials.
Arguments:
GIT_PROVIDER: Git provider. This field is case-insensitive. The available Git providers
are gitHub, bitbucketCloud, gitLab, azureDevOpsServices, gitHubEnterprise,
bitbucketServer, gitLabEnterpriseEdition and awsCodeCommit.`
cmd.Annotations = make(map[string]string)
@ -144,7 +149,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete a credential.`
cmd.Long = `Delete a credential.
Deletes the specified Git credential.`
Deletes the specified Git credential.
Arguments:
CREDENTIAL_ID: The ID for the corresponding credential to access.`
cmd.Annotations = make(map[string]string)
@ -220,7 +228,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get a credential entry.`
cmd.Long = `Get a credential entry.
Gets the Git credential with the specified credential ID.`
Gets the Git credential with the specified credential ID.
Arguments:
CREDENTIAL_ID: The ID for the corresponding credential to access.`
cmd.Annotations = make(map[string]string)
@ -351,7 +362,10 @@ func newUpdate() *cobra.Command {
cmd.Short = `Update a credential.`
cmd.Long = `Update a credential.
Updates the specified Git credential.`
Updates the specified Git credential.
Arguments:
CREDENTIAL_ID: The ID for the corresponding credential to access.`
cmd.Annotations = make(map[string]string)

23
cmd/workspace/global-init-scripts/global-init-scripts.go generated
View File

@ -68,7 +68,11 @@ func newCreate() *cobra.Command {
cmd.Short = `Create init script.`
cmd.Long = `Create init script.
Creates a new global init script in this workspace.`
Creates a new global init script in this workspace.
Arguments:
NAME: The name of the script
SCRIPT: The Base64-encoded content of the script.`
cmd.Annotations = make(map[string]string)
@ -147,7 +151,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete init script.`
cmd.Long = `Delete init script.
Deletes a global init script.`
Deletes a global init script.
Arguments:
SCRIPT_ID: The ID of the global init script.`
cmd.Annotations = make(map[string]string)
@ -220,7 +227,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get an init script.`
cmd.Long = `Get an init script.
Gets all the details of a script, including its Base64-encoded contents.`
Gets all the details of a script, including its Base64-encoded contents.
Arguments:
SCRIPT_ID: The ID of the global init script.`
cmd.Annotations = make(map[string]string)
@ -350,7 +360,12 @@ func newUpdate() *cobra.Command {
cmd.Long = `Update init script.
Updates a global init script, specifying only the fields to change. All fields
are optional. Unspecified fields retain their current value.`
are optional. Unspecified fields retain their current value.
Arguments:
SCRIPT_ID: The ID of the global init script.
NAME: The name of the script
SCRIPT: The Base64-encoded content of the script.`
cmd.Annotations = make(map[string]string)

18
cmd/workspace/grants/grants.go generated
View File

@ -67,7 +67,11 @@ func newGet() *cobra.Command {
cmd.Short = `Get permissions.`
cmd.Long = `Get permissions.
Gets the permissions for a securable.`
Gets the permissions for a securable.
Arguments:
SECURABLE_TYPE: Type of securable.
FULL_NAME: Full name of securable.`
cmd.Annotations = make(map[string]string)
@ -134,7 +138,11 @@ func newGetEffective() *cobra.Command {
cmd.Short = `Get effective permissions.`
cmd.Long = `Get effective permissions.
Gets the effective permissions for a securable.`
Gets the effective permissions for a securable.
Arguments:
SECURABLE_TYPE: Type of securable.
FULL_NAME: Full name of securable.`
cmd.Annotations = make(map[string]string)
@ -203,7 +211,11 @@ func newUpdate() *cobra.Command {
cmd.Short = `Update permissions.`
cmd.Long = `Update permissions.
Updates the permissions for a securable.`
Updates the permissions for a securable.
Arguments:
SECURABLE_TYPE: Type of securable.
FULL_NAME: Full name of securable.`
cmd.Annotations = make(map[string]string)

20
cmd/workspace/groups/groups.go generated
View File

@ -140,7 +140,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete a group.`
cmd.Long = `Delete a group.
Deletes a group from the Databricks workspace.`
Deletes a group from the Databricks workspace.
Arguments:
ID: Unique ID for a group in the Databricks workspace.`
cmd.Annotations = make(map[string]string)
@ -213,7 +216,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get group details.`
cmd.Long = `Get group details.
Gets the information for a specific group in the Databricks workspace.`
Gets the information for a specific group in the Databricks workspace.
Arguments:
ID: Unique ID for a group in the Databricks workspace.`
cmd.Annotations = make(map[string]string)
@ -358,7 +364,10 @@ func newPatch() *cobra.Command {
cmd.Short = `Update group details.`
cmd.Long = `Update group details.
Partially updates the details of a group.`
Partially updates the details of a group.
Arguments:
ID: Unique ID for a group in the Databricks workspace.`
cmd.Annotations = make(map[string]string)
@ -449,7 +458,10 @@ func newUpdate() *cobra.Command {
cmd.Short = `Replace a group.`
cmd.Long = `Replace a group.
Updates the details of a group by replacing the entire group entity.`
Updates the details of a group by replacing the entire group entity.
Arguments:
ID: Databricks group ID`
cmd.Annotations = make(map[string]string)

53
cmd/workspace/instance-pools/instance-pools.go generated
View File

@ -86,7 +86,16 @@ func newCreate() *cobra.Command {
cmd.Short = `Create a new instance pool.`
cmd.Long = `Create a new instance pool.
Creates a new instance pool using idle and ready-to-use cloud instances.`
Creates a new instance pool using idle and ready-to-use cloud instances.
Arguments:
INSTANCE_POOL_NAME: Pool name requested by the user. Pool name must be unique. Length must be
between 1 and 100 characters.
NODE_TYPE_ID: This field encodes, through a single value, the resources available to
each of the Spark nodes in this cluster. For example, the Spark nodes can
be provisioned and optimized for memory or compute intensive workloads. A
list of available node types can be retrieved by using the
:method:clusters/listNodeTypes API call.`
cmd.Annotations = make(map[string]string)
@ -168,7 +177,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete an instance pool.
Deletes the instance pool permanently. The idle instances in the pool are
terminated asynchronously.`
terminated asynchronously.
Arguments:
INSTANCE_POOL_ID: The instance pool to be terminated.`
cmd.Annotations = make(map[string]string)
@ -255,7 +267,17 @@ func newEdit() *cobra.Command {
cmd.Short = `Edit an existing instance pool.`
cmd.Long = `Edit an existing instance pool.
Modifies the configuration of an existing instance pool.`
Modifies the configuration of an existing instance pool.
Arguments:
INSTANCE_POOL_ID: Instance pool ID
INSTANCE_POOL_NAME: Pool name requested by the user. Pool name must be unique. Length must be
between 1 and 100 characters.
NODE_TYPE_ID: This field encodes, through a single value, the resources available to
each of the Spark nodes in this cluster. For example, the Spark nodes can
be provisioned and optimized for memory or compute intensive workloads. A
list of available node types can be retrieved by using the
:method:clusters/listNodeTypes API call.`
cmd.Annotations = make(map[string]string)
@ -337,7 +359,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get instance pool information.`
cmd.Long = `Get instance pool information.
Retrieve the information for an instance pool based on its identifier.`
Retrieve the information for an instance pool based on its identifier.
Arguments:
INSTANCE_POOL_ID: The canonical unique identifier for the instance pool.`
cmd.Annotations = make(map[string]string)
@ -410,7 +435,10 @@ func newGetPermissionLevels() *cobra.Command {
cmd.Short = `Get instance pool permission levels.`
cmd.Long = `Get instance pool permission levels.
Gets the permission levels that a user can have on an object.`
Gets the permission levels that a user can have on an object.
Arguments:
INSTANCE_POOL_ID: The instance pool for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -484,7 +512,10 @@ func newGetPermissions() *cobra.Command {
cmd.Long = `Get instance pool permissions.
Gets the permissions of an instance pool. Instance pools can inherit
permissions from their root object.`
permissions from their root object.
Arguments:
INSTANCE_POOL_ID: The instance pool for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -610,7 +641,10 @@ func newSetPermissions() *cobra.Command {
cmd.Long = `Set instance pool permissions.
Sets permissions on an instance pool. Instance pools can inherit permissions
from their root object.`
from their root object.
Arguments:
INSTANCE_POOL_ID: The instance pool for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -694,7 +728,10 @@ func newUpdatePermissions() *cobra.Command {
cmd.Long = `Update instance pool permissions.
Updates the permissions on an instance pool. Instance pools can inherit
permissions from their root object.`
permissions from their root object.
Arguments:
INSTANCE_POOL_ID: The instance pool for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)

17
cmd/workspace/instance-profiles/instance-profiles.go generated
View File

@ -67,7 +67,11 @@ func newAdd() *cobra.Command {
cmd.Long = `Register an instance profile.
In the UI, you can select the instance profile when launching clusters. This
API is only available to admin users.`
API is only available to admin users.
Arguments:
INSTANCE_PROFILE_ARN: The AWS ARN of the instance profile to register with Databricks. This
field is required.`
cmd.Annotations = make(map[string]string)
@ -162,7 +166,11 @@ func newEdit() *cobra.Command {
This API is only available to admin users.
[Databricks SQL Serverless]: https://docs.databricks.com/sql/admin/serverless.html
[Enable serverless SQL warehouses]: https://docs.databricks.com/sql/admin/serverless.html`
[Enable serverless SQL warehouses]: https://docs.databricks.com/sql/admin/serverless.html
Arguments:
INSTANCE_PROFILE_ARN: The AWS ARN of the instance profile to register with Databricks. This
field is required.`
cmd.Annotations = make(map[string]string)
@ -293,7 +301,10 @@ func newRemove() *cobra.Command {
Remove the instance profile with the provided ARN. Existing clusters with this
instance profile will continue to function.
This API is only accessible to admin users.`
This API is only accessible to admin users.
Arguments:
INSTANCE_PROFILE_ARN: The ARN of the instance profile to remove. This field is required.`
cmd.Annotations = make(map[string]string)

10
cmd/workspace/ip-access-lists/ip-access-lists.go generated
View File

@ -155,7 +155,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete access list.`
cmd.Long = `Delete access list.
Deletes an IP access list, specified by its list ID.`
Deletes an IP access list, specified by its list ID.
Arguments:
IP_ACCESS_LIST_ID: The ID for the corresponding IP access list to modify.`
cmd.Annotations = make(map[string]string)
@ -228,7 +231,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get access list.`
cmd.Long = `Get access list.
Gets an IP access list, specified by its list ID.`
Gets an IP access list, specified by its list ID.
Arguments:
IP_ACCESS_LIST_ID: The ID for the corresponding IP access list to modify.`
cmd.Annotations = make(map[string]string)

72
cmd/workspace/jobs/jobs.go generated
View File

@ -153,7 +153,10 @@ func newCancelRun() *cobra.Command {
cmd.Long = `Cancel a run.
Cancels a job run or a task run. The run is canceled asynchronously, so it may
still be running when this request completes.`
still be running when this request completes.
Arguments:
RUN_ID: This field is required.`
cmd.Annotations = make(map[string]string)
@ -322,7 +325,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete a job.`
cmd.Long = `Delete a job.
Deletes a job.`
Deletes a job.
Arguments:
JOB_ID: The canonical identifier of the job to delete. This field is required.`
cmd.Annotations = make(map[string]string)
@ -407,7 +413,10 @@ func newDeleteRun() *cobra.Command {
cmd.Short = `Delete a job run.`
cmd.Long = `Delete a job run.
Deletes a non-active run. Returns an error if the run is active.`
Deletes a non-active run. Returns an error if the run is active.
Arguments:
RUN_ID: The canonical identifier of the run for which to retrieve the metadata.`
cmd.Annotations = make(map[string]string)
@ -492,7 +501,10 @@ func newExportRun() *cobra.Command {
cmd.Short = `Export and retrieve a job run.`
cmd.Long = `Export and retrieve a job run.
Export and retrieve the job run task.`
Export and retrieve the job run task.
Arguments:
RUN_ID: The canonical identifier for the run. This field is required.`
cmd.Annotations = make(map[string]string)
@ -568,7 +580,11 @@ func newGet() *cobra.Command {
cmd.Short = `Get a single job.`
cmd.Long = `Get a single job.
Retrieves the details for a single job.`
Retrieves the details for a single job.
Arguments:
JOB_ID: The canonical identifier of the job to retrieve information about. This
field is required.`
cmd.Annotations = make(map[string]string)
@ -644,7 +660,10 @@ func newGetPermissionLevels() *cobra.Command {
cmd.Short = `Get job permission levels.`
cmd.Long = `Get job permission levels.
Gets the permission levels that a user can have on an object.`
Gets the permission levels that a user can have on an object.
Arguments:
JOB_ID: The job for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -718,7 +737,10 @@ func newGetPermissions() *cobra.Command {
cmd.Long = `Get job permissions.
Gets the permissions of a job. Jobs can inherit permissions from their root
object.`
object.
Arguments:
JOB_ID: The job for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -799,7 +821,11 @@ func newGetRun() *cobra.Command {
cmd.Short = `Get a single job run.`
cmd.Long = `Get a single job run.
Retrieve the metadata of a run.`
Retrieve the metadata of a run.
Arguments:
RUN_ID: The canonical identifier of the run for which to retrieve the metadata.
This field is required.`
cmd.Annotations = make(map[string]string)
@ -884,7 +910,10 @@ func newGetRunOutput() *cobra.Command {
This endpoint validates that the __run_id__ parameter is valid and returns an
HTTP status code 400 if the __run_id__ parameter is invalid. Runs are
automatically removed after 60 days. If you to want to reference them beyond
60 days, you must save old run results before they expire.`
60 days, you must save old run results before they expire.
Arguments:
RUN_ID: The canonical identifier for the run. This field is required.`
cmd.Annotations = make(map[string]string)
@ -1118,7 +1147,10 @@ func newRepairRun() *cobra.Command {
Re-run one or more tasks. Tasks are re-run as part of the original job run.
They use the current job and task settings, and can be viewed in the history
for the original job run.`
for the original job run.
Arguments:
RUN_ID: The job run ID of the run to repair. The run must not be in progress.`
cmd.Annotations = make(map[string]string)
@ -1305,7 +1337,10 @@ func newRunNow() *cobra.Command {
cmd.Short = `Trigger a new job run.`
cmd.Long = `Trigger a new job run.
Run a job and return the run_id of the triggered run.`
Run a job and return the run_id of the triggered run.
Arguments:
JOB_ID: The ID of the job to be executed`
cmd.Annotations = make(map[string]string)
@ -1412,7 +1447,10 @@ func newSetPermissions() *cobra.Command {
cmd.Long = `Set job permissions.
Sets permissions on a job. Jobs can inherit permissions from their root
object.`
object.
Arguments:
JOB_ID: The job for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -1604,7 +1642,10 @@ func newUpdate() *cobra.Command {
cmd.Long = `Partially update a job.
Add, update, or remove specific settings of an existing job. Use the ResetJob
to overwrite all job settings.`
to overwrite all job settings.
Arguments:
JOB_ID: The canonical identifier of the job to update. This field is required.`
cmd.Annotations = make(map[string]string)
@ -1692,7 +1733,10 @@ func newUpdatePermissions() *cobra.Command {
cmd.Long = `Update job permissions.
Updates the permissions on a job. Jobs can inherit permissions from their root
object.`
object.
Arguments:
JOB_ID: The job for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)

5
cmd/workspace/libraries/libraries.go generated
View File

@ -138,7 +138,10 @@ func newClusterStatus() *cobra.Command {
3. Libraries that were previously requested on this cluster or on all
clusters, but now marked for removal. Within this group there is no order
guarantee.`
guarantee.
Arguments:
CLUSTER_ID: Unique identifier of the cluster whose status should be retrieved.`
cmd.Annotations = make(map[string]string)

38
cmd/workspace/metastores/metastores.go generated
View File

@ -71,7 +71,12 @@ func newAssign() *cobra.Command {
Creates a new metastore assignment. If an assignment for the same
__workspace_id__ exists, it will be overwritten by the new __metastore_id__
and __default_catalog_name__. The caller must be an account admin.`
and __default_catalog_name__. The caller must be an account admin.
Arguments:
WORKSPACE_ID: A workspace ID.
METASTORE_ID: The unique ID of the metastore.
DEFAULT_CATALOG_NAME: The name of the default catalog in the metastore.`
cmd.Annotations = make(map[string]string)
@ -163,7 +168,10 @@ func newCreate() *cobra.Command {
path. By default (if the __owner__ field is not set), the owner of the new
metastore is the user calling the __createMetastore__ API. If the __owner__
field is set to the empty string (**""**), the ownership is assigned to the
System User instead.`
System User instead.
Arguments:
NAME: The user-specified name of the metastore.`
cmd.Annotations = make(map[string]string)
@ -289,7 +297,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete a metastore.`
cmd.Long = `Delete a metastore.
Deletes a metastore. The caller must be a metastore admin.`
Deletes a metastore. The caller must be a metastore admin.
Arguments:
ID: Unique ID of the metastore.`
cmd.Annotations = make(map[string]string)
@ -363,7 +374,10 @@ func newGet() *cobra.Command {
cmd.Long = `Get a metastore.
Gets a metastore that matches the supplied ID. The caller must be a metastore
admin to retrieve this info.`
admin to retrieve this info.
Arguments:
ID: Unique ID of the metastore.`
cmd.Annotations = make(map[string]string)
@ -535,7 +549,11 @@ func newUnassign() *cobra.Command {
cmd.Short = `Delete an assignment.`
cmd.Long = `Delete an assignment.
Deletes a metastore assignment. The caller must be an account administrator.`
Deletes a metastore assignment. The caller must be an account administrator.
Arguments:
WORKSPACE_ID: A workspace ID.
METASTORE_ID: Query for the ID of the metastore to delete.`
cmd.Annotations = make(map[string]string)
@ -612,7 +630,10 @@ func newUpdate() *cobra.Command {
Updates information for a specific metastore. The caller must be a metastore
admin. If the __owner__ field is set to the empty string (**""**), the
ownership is updated to the System User.`
ownership is updated to the System User.
Arguments:
ID: Unique ID of the metastore.`
cmd.Annotations = make(map[string]string)
@ -699,7 +720,10 @@ func newUpdateAssignment() *cobra.Command {
Updates a metastore assignment. This operation can be used to update
__metastore_id__ or __default_catalog_name__ for a specified Workspace, if the
Workspace is already assigned a metastore. The caller must be an account admin
to update __metastore_id__; otherwise, the caller can be a Workspace admin.`
to update __metastore_id__; otherwise, the caller can be a Workspace admin.
Arguments:
WORKSPACE_ID: A workspace ID.`
cmd.Annotations = make(map[string]string)

231
cmd/workspace/model-registry/model-registry.go generated
View File

@ -66,7 +66,22 @@ func newApproveTransitionRequest() *cobra.Command {
cmd.Short = `Approve transition request.`
cmd.Long = `Approve transition request.
Approves a model version stage transition request.`
Approves a model version stage transition request.
Arguments:
NAME: Name of the model.
VERSION: Version of the model.
STAGE: Target stage of the transition. Valid values are:
* None: The initial stage of a model version.
* Staging: Staging or pre-production stage.
* Production: Production stage.
* Archived: Archived stage.
ARCHIVE_EXISTING_VERSIONS: Specifies whether to archive all current model versions in the target
stage.`
cmd.Annotations = make(map[string]string)
@ -161,7 +176,12 @@ func newCreateComment() *cobra.Command {
Posts a comment on a model version. A comment can be submitted either by a
user or programmatically to display relevant information about the model. For
example, test results or deployment errors.`
example, test results or deployment errors.
Arguments:
NAME: Name of the model.
VERSION: Version of the model.
COMMENT: User-provided comment on the action.`
cmd.Annotations = make(map[string]string)
@ -251,7 +271,10 @@ func newCreateModel() *cobra.Command {
Creates a new registered model with the name specified in the request body.
Throws RESOURCE_ALREADY_EXISTS if a registered model with the given name
exists.`
exists.
Arguments:
NAME: Register models under this name`
cmd.Annotations = make(map[string]string)
@ -334,7 +357,11 @@ func newCreateModelVersion() *cobra.Command {
cmd.Short = `Create a model version.`
cmd.Long = `Create a model version.
Creates a model version.`
Creates a model version.
Arguments:
NAME: Register model under this name
SOURCE: URI indicating the location of the model artifacts.`
cmd.Annotations = make(map[string]string)
@ -417,7 +444,20 @@ func newCreateTransitionRequest() *cobra.Command {
cmd.Short = `Make a transition request.`
cmd.Long = `Make a transition request.
Creates a model version stage transition request.`
Creates a model version stage transition request.
Arguments:
NAME: Name of the model.
VERSION: Version of the model.
STAGE: Target stage of the transition. Valid values are:
* None: The initial stage of a model version.
* Staging: Staging or pre-production stage.
* Production: Production stage.
* Archived: Archived stage.`
cmd.Annotations = make(map[string]string)
@ -636,7 +676,10 @@ func newDeleteModel() *cobra.Command {
cmd.Short = `Delete a model.`
cmd.Long = `Delete a model.
Deletes a registered model.`
Deletes a registered model.
Arguments:
NAME: Registered model unique name identifier.`
cmd.Annotations = make(map[string]string)
@ -697,7 +740,12 @@ func newDeleteModelTag() *cobra.Command {
cmd.Short = `Delete a model tag.`
cmd.Long = `Delete a model tag.
Deletes the tag for a registered model.`
Deletes the tag for a registered model.
Arguments:
NAME: Name of the registered model that the tag was logged under.
KEY: Name of the tag. The name must be an exact match; wild-card deletion is
not supported. Maximum size is 250 bytes.`
cmd.Annotations = make(map[string]string)
@ -759,7 +807,11 @@ func newDeleteModelVersion() *cobra.Command {
cmd.Short = `Delete a model version.`
cmd.Long = `Delete a model version.
Deletes a model version.`
Deletes a model version.
Arguments:
NAME: Name of the registered model
VERSION: Model version number`
cmd.Annotations = make(map[string]string)
@ -821,7 +873,13 @@ func newDeleteModelVersionTag() *cobra.Command {
cmd.Short = `Delete a model version tag.`
cmd.Long = `Delete a model version tag.
Deletes a model version tag.`
Deletes a model version tag.
Arguments:
NAME: Name of the registered model that the tag was logged under.
VERSION: Model version number that the tag was logged under.
KEY: Name of the tag. The name must be an exact match; wild-card deletion is
not supported. Maximum size is 250 bytes.`
cmd.Annotations = make(map[string]string)
@ -886,7 +944,23 @@ func newDeleteTransitionRequest() *cobra.Command {
cmd.Short = `Delete a transition request.`
cmd.Long = `Delete a transition request.
Cancels a model version stage transition request.`
Cancels a model version stage transition request.
Arguments:
NAME: Name of the model.
VERSION: Version of the model.
STAGE: Target stage of the transition request. Valid values are:
* None: The initial stage of a model version.
* Staging: Staging or pre-production stage.
* Production: Production stage.
* Archived: Archived stage.
CREATOR: Username of the user who created this request. Of the transition requests
matching the specified details, only the one transition created by this
user will be deleted.`
cmd.Annotations = make(map[string]string)
@ -1020,7 +1094,10 @@ func newGetLatestVersions() *cobra.Command {
cmd.Short = `Get the latest version.`
cmd.Long = `Get the latest version.
Gets the latest version of a registered model.`
Gets the latest version of a registered model.
Arguments:
NAME: Registered model unique name identifier.`
cmd.Annotations = make(map[string]string)
@ -1100,7 +1177,10 @@ func newGetModel() *cobra.Command {
[MLflow endpoint] that also returns the model's Databricks workspace ID and
the permission level of the requesting user on the model.
[MLflow endpoint]: https://www.mlflow.org/docs/latest/rest-api.html#get-registeredmodel`
[MLflow endpoint]: https://www.mlflow.org/docs/latest/rest-api.html#get-registeredmodel
Arguments:
NAME: Registered model unique name identifier.`
cmd.Annotations = make(map[string]string)
@ -1161,7 +1241,11 @@ func newGetModelVersion() *cobra.Command {
cmd.Short = `Get a model version.`
cmd.Long = `Get a model version.
Get a model version.`
Get a model version.
Arguments:
NAME: Name of the registered model
VERSION: Model version number`
cmd.Annotations = make(map[string]string)
@ -1223,7 +1307,11 @@ func newGetModelVersionDownloadUri() *cobra.Command {
cmd.Short = `Get a model version URI.`
cmd.Long = `Get a model version URI.
Gets a URI to download the model version.`
Gets a URI to download the model version.
Arguments:
NAME: Name of the registered model
VERSION: Model version number`
cmd.Annotations = make(map[string]string)
@ -1285,7 +1373,10 @@ func newGetPermissionLevels() *cobra.Command {
cmd.Short = `Get registered model permission levels.`
cmd.Long = `Get registered model permission levels.
Gets the permission levels that a user can have on an object.`
Gets the permission levels that a user can have on an object.
Arguments:
REGISTERED_MODEL_ID: The registered model for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -1347,7 +1438,10 @@ func newGetPermissions() *cobra.Command {
cmd.Long = `Get registered model permissions.
Gets the permissions of a registered model. Registered models can inherit
permissions from their root object.`
permissions from their root object.
Arguments:
REGISTERED_MODEL_ID: The registered model for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -1471,7 +1565,11 @@ func newListTransitionRequests() *cobra.Command {
cmd.Short = `List transition requests.`
cmd.Long = `List transition requests.
Gets a list of all open stage transition requests for the model version.`
Gets a list of all open stage transition requests for the model version.
Arguments:
NAME: Name of the model.
VERSION: Version of the model.`
cmd.Annotations = make(map[string]string)
@ -1602,7 +1700,20 @@ func newRejectTransitionRequest() *cobra.Command {
cmd.Short = `Reject a transition request.`
cmd.Long = `Reject a transition request.
Rejects a model version stage transition request.`
Rejects a model version stage transition request.
Arguments:
NAME: Name of the model.
VERSION: Version of the model.
STAGE: Target stage of the transition. Valid values are:
* None: The initial stage of a model version.
* Staging: Staging or pre-production stage.
* Production: Production stage.
* Archived: Archived stage.`
cmd.Annotations = make(map[string]string)
@ -1691,7 +1802,10 @@ func newRenameModel() *cobra.Command {
cmd.Short = `Rename a model.`
cmd.Long = `Rename a model.
Renames a registered model.`
Renames a registered model.
Arguments:
NAME: Registered model unique name identifier.`
cmd.Annotations = make(map[string]string)
@ -1897,7 +2011,17 @@ func newSetModelTag() *cobra.Command {
cmd.Short = `Set a tag.`
cmd.Long = `Set a tag.
Sets a tag on a registered model.`
Sets a tag on a registered model.
Arguments:
NAME: Unique name of the model.
KEY: Name of the tag. Maximum size depends on storage backend. If a tag with
this name already exists, its preexisting value will be replaced by the
specified value. All storage backends are guaranteed to support key
values up to 250 bytes in size.
VALUE: String value of the tag being logged. Maximum size depends on storage
backend. All storage backends are guaranteed to support key values up to
5000 bytes in size.`
cmd.Annotations = make(map[string]string)
@ -1981,7 +2105,18 @@ func newSetModelVersionTag() *cobra.Command {
cmd.Short = `Set a version tag.`
cmd.Long = `Set a version tag.
Sets a model version tag.`
Sets a model version tag.
Arguments:
NAME: Unique name of the model.
VERSION: Model version number.
KEY: Name of the tag. Maximum size depends on storage backend. If a tag with
this name already exists, its preexisting value will be replaced by the
specified value. All storage backends are guaranteed to support key
values up to 250 bytes in size.
VALUE: String value of the tag being logged. Maximum size depends on storage
backend. All storage backends are guaranteed to support key values up to
5000 bytes in size.`
cmd.Annotations = make(map[string]string)
@ -2071,7 +2206,10 @@ func newSetPermissions() *cobra.Command {
cmd.Long = `Set registered model permissions.
Sets permissions on a registered model. Registered models can inherit
permissions from their root object.`
permissions from their root object.
Arguments:
REGISTERED_MODEL_ID: The registered model for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -2144,7 +2282,10 @@ func newTestRegistryWebhook() *cobra.Command {
**NOTE:** This endpoint is in Public Preview.
Tests a registry webhook.`
Tests a registry webhook.
Arguments:
ID: Webhook ID`
cmd.Annotations = make(map[string]string)
@ -2228,7 +2369,22 @@ func newTransitionStage() *cobra.Command {
the [MLflow endpoint] that also accepts a comment associated with the
transition to be recorded.",
[MLflow endpoint]: https://www.mlflow.org/docs/latest/rest-api.html#transition-modelversion-stage`
[MLflow endpoint]: https://www.mlflow.org/docs/latest/rest-api.html#transition-modelversion-stage
Arguments:
NAME: Name of the model.
VERSION: Version of the model.
STAGE: Target stage of the transition. Valid values are:
* None: The initial stage of a model version.
* Staging: Staging or pre-production stage.
* Production: Production stage.
* Archived: Archived stage.
ARCHIVE_EXISTING_VERSIONS: Specifies whether to archive all current model versions in the target
stage.`
cmd.Annotations = make(map[string]string)
@ -2321,7 +2477,11 @@ func newUpdateComment() *cobra.Command {
cmd.Short = `Update a comment.`
cmd.Long = `Update a comment.
Post an edit to a comment on a model version.`
Post an edit to a comment on a model version.
Arguments:
ID: Unique identifier of an activity
COMMENT: User-provided comment on the action.`
cmd.Annotations = make(map[string]string)
@ -2404,7 +2564,10 @@ func newUpdateModel() *cobra.Command {
cmd.Short = `Update model.`
cmd.Long = `Update model.
Updates a registered model.`
Updates a registered model.
Arguments:
NAME: Registered model unique name identifier.`
cmd.Annotations = make(map[string]string)
@ -2484,7 +2647,11 @@ func newUpdateModelVersion() *cobra.Command {
cmd.Short = `Update model version.`
cmd.Long = `Update model version.
Updates the model version.`
Updates the model version.
Arguments:
NAME: Name of the registered model
VERSION: Model version number`
cmd.Annotations = make(map[string]string)
@ -2568,7 +2735,10 @@ func newUpdatePermissions() *cobra.Command {
cmd.Long = `Update registered model permissions.
Updates the permissions on a registered model. Registered models can inherit
permissions from their root object.`
permissions from their root object.
Arguments:
REGISTERED_MODEL_ID: The registered model for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -2645,7 +2815,10 @@ func newUpdateWebhook() *cobra.Command {
**NOTE:** This endpoint is in Public Preview.
Updates a registry webhook.`
Updates a registry webhook.
Arguments:
ID: Webhook ID`
cmd.Annotations = make(map[string]string)

30
cmd/workspace/model-versions/model-versions.go generated
View File

@ -67,7 +67,11 @@ func newDelete() *cobra.Command {
The caller must be a metastore admin or an owner of the parent registered
model. For the latter case, the caller must also be the owner or have the
**USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA**
privilege on the parent schema.`
privilege on the parent schema.
Arguments:
FULL_NAME: The three-level (fully qualified) name of the model version
VERSION: The integer version number of the model version`
cmd.Annotations = make(map[string]string)
@ -137,7 +141,11 @@ func newGet() *cobra.Command {
The caller must be a metastore admin or an owner of (or have the **EXECUTE**
privilege on) the parent registered model. For the latter case, the caller
must also be the owner or have the **USE_CATALOG** privilege on the parent
catalog and the **USE_SCHEMA** privilege on the parent schema.`
catalog and the **USE_SCHEMA** privilege on the parent schema.
Arguments:
FULL_NAME: The three-level (fully qualified) name of the model version
VERSION: The integer version number of the model version`
cmd.Annotations = make(map[string]string)
@ -207,7 +215,11 @@ func newGetByAlias() *cobra.Command {
The caller must be a metastore admin or an owner of (or have the **EXECUTE**
privilege on) the registered model. For the latter case, the caller must also
be the owner or have the **USE_CATALOG** privilege on the parent catalog and
the **USE_SCHEMA** privilege on the parent schema.`
the **USE_SCHEMA** privilege on the parent schema.
Arguments:
FULL_NAME: The three-level (fully qualified) name of the registered model
ALIAS: The name of the alias`
cmd.Annotations = make(map[string]string)
@ -283,7 +295,11 @@ func newList() *cobra.Command {
privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
schema.
There is no guarantee of a specific ordering of the elements in the response.`
There is no guarantee of a specific ordering of the elements in the response.
Arguments:
FULL_NAME: The full three-level name of the registered model under which to list
model versions`
cmd.Annotations = make(map[string]string)
@ -355,7 +371,11 @@ func newUpdate() *cobra.Command {
**USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA**
privilege on the parent schema.
Currently only the comment of the model version can be updated.`
Currently only the comment of the model version can be updated.
Arguments:
FULL_NAME: The three-level (fully qualified) name of the model version
VERSION: The integer version number of the model version`
cmd.Annotations = make(map[string]string)

24
cmd/workspace/permissions/permissions.go generated
View File

@ -100,7 +100,11 @@ func newGet() *cobra.Command {
cmd.Long = `Get object permissions.
Gets the permissions of an object. Objects can inherit permissions from their
parent objects or root object.`
parent objects or root object.
Arguments:
REQUEST_OBJECT_TYPE: <needs content>
REQUEST_OBJECT_ID: `
cmd.Annotations = make(map[string]string)
@ -162,7 +166,11 @@ func newGetPermissionLevels() *cobra.Command {
cmd.Short = `Get object permission levels.`
cmd.Long = `Get object permission levels.
Gets the permission levels that a user can have on an object.`
Gets the permission levels that a user can have on an object.
Arguments:
REQUEST_OBJECT_TYPE: <needs content>
REQUEST_OBJECT_ID: <needs content>`
cmd.Annotations = make(map[string]string)
@ -229,7 +237,11 @@ func newSet() *cobra.Command {
cmd.Long = `Set object permissions.
Sets permissions on an object. Objects can inherit permissions from their
parent objects or root object.`
parent objects or root object.
Arguments:
REQUEST_OBJECT_TYPE: <needs content>
REQUEST_OBJECT_ID: `
cmd.Annotations = make(map[string]string)
@ -302,7 +314,11 @@ func newUpdate() *cobra.Command {
cmd.Long = `Update object permissions.
Updates the permissions on an object. Objects can inherit permissions from
their parent objects or root object.`
their parent objects or root object.
Arguments:
REQUEST_OBJECT_TYPE: <needs content>
REQUEST_OBJECT_ID: `
cmd.Annotations = make(map[string]string)

36
cmd/workspace/pipelines/pipelines.go generated
View File

@ -284,7 +284,10 @@ func newGetPermissionLevels() *cobra.Command {
cmd.Short = `Get pipeline permission levels.`
cmd.Long = `Get pipeline permission levels.
Gets the permission levels that a user can have on an object.`
Gets the permission levels that a user can have on an object.
Arguments:
PIPELINE_ID: The pipeline for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -358,7 +361,10 @@ func newGetPermissions() *cobra.Command {
cmd.Long = `Get pipeline permissions.
Gets the permissions of a pipeline. Pipelines can inherit permissions from
their root object.`
their root object.
Arguments:
PIPELINE_ID: The pipeline for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -431,7 +437,11 @@ func newGetUpdate() *cobra.Command {
cmd.Short = `Get a pipeline update.`
cmd.Long = `Get a pipeline update.
Gets an update from an active pipeline.`
Gets an update from an active pipeline.
Arguments:
PIPELINE_ID: The ID of the pipeline.
UPDATE_ID: The ID of the update.`
cmd.Annotations = make(map[string]string)
@ -639,7 +649,10 @@ func newListUpdates() *cobra.Command {
cmd.Short = `List pipeline updates.`
cmd.Long = `List pipeline updates.
List updates for an active pipeline.`
List updates for an active pipeline.
Arguments:
PIPELINE_ID: The pipeline to return updates for.`
cmd.Annotations = make(map[string]string)
@ -807,7 +820,10 @@ func newSetPermissions() *cobra.Command {
cmd.Long = `Set pipeline permissions.
Sets permissions on a pipeline. Pipelines can inherit permissions from their
root object.`
root object.
Arguments:
PIPELINE_ID: The pipeline for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -1087,7 +1103,10 @@ func newUpdate() *cobra.Command {
cmd.Short = `Edit a pipeline.`
cmd.Long = `Edit a pipeline.
Updates a pipeline with the supplied configuration.`
Updates a pipeline with the supplied configuration.
Arguments:
PIPELINE_ID: Unique identifier for this pipeline.`
cmd.Annotations = make(map[string]string)
@ -1171,7 +1190,10 @@ func newUpdatePermissions() *cobra.Command {
cmd.Long = `Update pipeline permissions.
Updates the permissions on a pipeline. Pipelines can inherit permissions from
their root object.`
their root object.
Arguments:
PIPELINE_ID: The pipeline for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)

26
cmd/workspace/providers/providers.go generated
View File

@ -63,7 +63,11 @@ func newCreate() *cobra.Command {
cmd.Long = `Create an auth provider.
Creates a new authentication provider minimally based on a name and
authentication type. The caller must be an admin on the metastore.`
authentication type. The caller must be an admin on the metastore.
Arguments:
NAME: The name of the Provider.
AUTHENTICATION_TYPE: The delta sharing authentication type.`
cmd.Annotations = make(map[string]string)
@ -146,7 +150,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete a provider.
Deletes an authentication provider, if the caller is a metastore admin or is
the owner of the provider.`
the owner of the provider.
Arguments:
NAME: Name of the provider.`
cmd.Annotations = make(map[string]string)
@ -221,7 +228,10 @@ func newGet() *cobra.Command {
Gets a specific authentication provider. The caller must supply the name of
the provider, and must either be a metastore admin or the owner of the
provider.`
provider.
Arguments:
NAME: Name of the provider.`
cmd.Annotations = make(map[string]string)
@ -360,7 +370,10 @@ func newListShares() *cobra.Command {
Gets an array of a specified provider's shares within the metastore where:
* the caller is a metastore admin, or * the caller is the owner.`
* the caller is a metastore admin, or * the caller is the owner.
Arguments:
NAME: Name of the provider in which to list shares.`
cmd.Annotations = make(map[string]string)
@ -443,7 +456,10 @@ func newUpdate() *cobra.Command {
Updates the information for an authentication provider, if the caller is a
metastore admin or is the owner of the provider. If the update changes the
provider name, the caller must be both a metastore admin and the owner of the
provider.`
provider.
Arguments:
NAME: The name of the Provider.`
cmd.Annotations = make(map[string]string)

10
cmd/workspace/recipient-activation/recipient-activation.go generated
View File

@ -61,7 +61,10 @@ func newGetActivationUrlInfo() *cobra.Command {
cmd.Short = `Get a share activation URL.`
cmd.Long = `Get a share activation URL.
Gets an activation URL for a share.`
Gets an activation URL for a share.
Arguments:
ACTIVATION_URL: The one time activation url. It also accepts activation token.`
cmd.Annotations = make(map[string]string)
@ -123,7 +126,10 @@ func newRetrieveToken() *cobra.Command {
cmd.Long = `Get an access token.
Retrieve access token with an activation url. This is a public API without any
authentication.`
authentication.
Arguments:
ACTIVATION_URL: The one time activation url. It also accepts activation token.`
cmd.Annotations = make(map[string]string)

35
cmd/workspace/recipients/recipients.go generated
View File

@ -82,7 +82,11 @@ func newCreate() *cobra.Command {
Creates a new recipient with the delta sharing authentication type in the
metastore. The caller must be a metastore admin or has the
**CREATE_RECIPIENT** privilege on the metastore.`
**CREATE_RECIPIENT** privilege on the metastore.
Arguments:
NAME: Name of Recipient.
AUTHENTICATION_TYPE: The delta sharing authentication type.`
cmd.Annotations = make(map[string]string)
@ -165,7 +169,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete a share recipient.
Deletes the specified recipient from the metastore. The caller must be the
owner of the recipient.`
owner of the recipient.
Arguments:
NAME: Name of the recipient.`
cmd.Annotations = make(map[string]string)
@ -240,7 +247,10 @@ func newGet() *cobra.Command {
Gets a share recipient from the metastore if:
* the caller is the owner of the share recipient, or: * is a metastore admin`
* the caller is the owner of the share recipient, or: * is a metastore admin
Arguments:
NAME: Name of the recipient.`
cmd.Annotations = make(map[string]string)
@ -380,7 +390,14 @@ func newRotateToken() *cobra.Command {
cmd.Long = `Rotate a token.
Refreshes the specified recipient's delta sharing authentication token with
the provided token info. The caller must be the owner of the recipient.`
the provided token info. The caller must be the owner of the recipient.
Arguments:
NAME: The name of the recipient.
EXISTING_TOKEN_EXPIRE_IN_SECONDS: The expiration time of the bearer token in ISO 8601 format. This will set
the expiration_time of existing token only to a smaller timestamp, it
cannot extend the expiration_time. Use 0 to expire the existing token
immediately, negative number will return an error.`
cmd.Annotations = make(map[string]string)
@ -461,7 +478,10 @@ func newSharePermissions() *cobra.Command {
cmd.Long = `Get recipient share permissions.
Gets the share permissions for the specified Recipient. The caller must be a
metastore admin or the owner of the Recipient.`
metastore admin or the owner of the Recipient.
Arguments:
NAME: The name of the Recipient.`
cmd.Annotations = make(map[string]string)
@ -544,7 +564,10 @@ func newUpdate() *cobra.Command {
Updates an existing recipient in the metastore. The caller must be a metastore
admin or the owner of the recipient. If the recipient name will be updated,
the user must be both a metastore admin and the owner of the recipient.`
the user must be both a metastore admin and the owner of the recipient.
Arguments:
NAME: Name of Recipient.`
cmd.Annotations = make(map[string]string)

35
cmd/workspace/registered-models/registered-models.go generated
View File

@ -99,7 +99,12 @@ func newCreate() *cobra.Command {
parent catalog and schema, or have the **USE_CATALOG** privilege on the parent
catalog and the **USE_SCHEMA** privilege on the parent schema. - The caller
must have the **CREATE MODEL** or **CREATE FUNCTION** privilege on the parent
schema.`
schema.
Arguments:
CATALOG_NAME: The name of the catalog where the schema and the registered model reside
SCHEMA_NAME: The name of the schema where the registered model resides
NAME: The name of the registered model`
cmd.Annotations = make(map[string]string)
@ -187,7 +192,10 @@ func newDelete() *cobra.Command {
The caller must be a metastore admin or an owner of the registered model. For
the latter case, the caller must also be the owner or have the **USE_CATALOG**
privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
schema.`
schema.
Arguments:
FULL_NAME: The three-level (fully qualified) name of the registered model`
cmd.Annotations = make(map[string]string)
@ -265,7 +273,11 @@ func newDeleteAlias() *cobra.Command {
The caller must be a metastore admin or an owner of the registered model. For
the latter case, the caller must also be the owner or have the **USE_CATALOG**
privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
schema.`
schema.
Arguments:
FULL_NAME: The three-level (fully qualified) name of the registered model
ALIAS: The name of the alias`
cmd.Annotations = make(map[string]string)
@ -332,7 +344,10 @@ func newGet() *cobra.Command {
The caller must be a metastore admin or an owner of (or have the **EXECUTE**
privilege on) the registered model. For the latter case, the caller must also
be the owner or have the **USE_CATALOG** privilege on the parent catalog and
the **USE_SCHEMA** privilege on the parent schema.`
the **USE_SCHEMA** privilege on the parent schema.
Arguments:
FULL_NAME: The three-level (fully qualified) name of the registered model`
cmd.Annotations = make(map[string]string)
@ -487,7 +502,12 @@ func newSetAlias() *cobra.Command {
The caller must be a metastore admin or an owner of the registered model. For
the latter case, the caller must also be the owner or have the **USE_CATALOG**
privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
schema.`
schema.
Arguments:
FULL_NAME: Full name of the registered model
ALIAS: The name of the alias
VERSION_NUM: The version number of the model version to which the alias points`
cmd.Annotations = make(map[string]string)
@ -582,7 +602,10 @@ func newUpdate() *cobra.Command {
schema.
Currently only the name, the owner or the comment of the registered model can
be updated.`
be updated.
Arguments:
FULL_NAME: The three-level (fully qualified) name of the registered model`
cmd.Annotations = make(map[string]string)

43
cmd/workspace/repos/repos.go generated
View File

@ -71,7 +71,13 @@ func newCreate() *cobra.Command {
Creates a repo in the workspace and links it to the remote Git repo specified.
Note that repos created programmatically must be linked to a remote Git repo,
unlike repos created in the browser.`
unlike repos created in the browser.
Arguments:
URL: URL of the Git repository to be linked.
PROVIDER: Git provider. This field is case-insensitive. The available Git providers
are gitHub, bitbucketCloud, gitLab, azureDevOpsServices, gitHubEnterprise,
bitbucketServer, gitLabEnterpriseEdition and awsCodeCommit.`
cmd.Annotations = make(map[string]string)
@ -150,7 +156,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete a repo.`
cmd.Long = `Delete a repo.
Deletes the specified repo.`
Deletes the specified repo.
Arguments:
REPO_ID: The ID for the corresponding repo to access.`
cmd.Annotations = make(map[string]string)
@ -226,7 +235,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get a repo.`
cmd.Long = `Get a repo.
Returns the repo with the given repo ID.`
Returns the repo with the given repo ID.
Arguments:
REPO_ID: The ID for the corresponding repo to access.`
cmd.Annotations = make(map[string]string)
@ -302,7 +314,10 @@ func newGetPermissionLevels() *cobra.Command {
cmd.Short = `Get repo permission levels.`
cmd.Long = `Get repo permission levels.
Gets the permission levels that a user can have on an object.`
Gets the permission levels that a user can have on an object.
Arguments:
REPO_ID: The repo for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -376,7 +391,10 @@ func newGetPermissions() *cobra.Command {
cmd.Long = `Get repo permissions.
Gets the permissions of a repo. Repos can inherit permissions from their root
object.`
object.
Arguments:
REPO_ID: The repo for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -517,7 +535,10 @@ func newSetPermissions() *cobra.Command {
cmd.Long = `Set repo permissions.
Sets permissions on a repo. Repos can inherit permissions from their root
object.`
object.
Arguments:
REPO_ID: The repo for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -603,7 +624,10 @@ func newUpdate() *cobra.Command {
cmd.Long = `Update a repo.
Updates the repo to a different branch or tag, or updates the repo to the
latest commit on the same branch.`
latest commit on the same branch.
Arguments:
REPO_ID: The ID for the corresponding repo to access.`
cmd.Annotations = make(map[string]string)
@ -690,7 +714,10 @@ func newUpdatePermissions() *cobra.Command {
cmd.Long = `Update repo permissions.
Updates the permissions on a repo. Repos can inherit permissions from their
root object.`
root object.
Arguments:
REPO_ID: The repo for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)

26
cmd/workspace/schemas/schemas.go generated
View File

@ -67,7 +67,11 @@ func newCreate() *cobra.Command {
Creates a new schema for catalog in the Metatastore. The caller must be a
metastore admin, or have the **CREATE_SCHEMA** privilege in the parent
catalog.`
catalog.
Arguments:
NAME: Name of schema, relative to parent catalog.
CATALOG_NAME: Name of parent catalog.`
cmd.Annotations = make(map[string]string)
@ -147,7 +151,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete a schema.
Deletes the specified schema from the parent catalog. The caller must be the
owner of the schema or an owner of the parent catalog.`
owner of the schema or an owner of the parent catalog.
Arguments:
FULL_NAME: Full name of the schema.`
cmd.Annotations = make(map[string]string)
@ -222,7 +229,10 @@ func newGet() *cobra.Command {
Gets the specified schema within the metastore. The caller must be a metastore
admin, the owner of the schema, or a user that has the **USE_SCHEMA**
privilege on the schema.`
privilege on the schema.
Arguments:
FULL_NAME: Full name of the schema.`
cmd.Annotations = make(map[string]string)
@ -299,7 +309,10 @@ func newList() *cobra.Command {
metastore admin or the owner of the parent catalog, all schemas for the
catalog will be retrieved. Otherwise, only schemas owned by the caller (or for
which the caller has the **USE_SCHEMA** privilege) will be retrieved. There is
no guarantee of a specific ordering of the elements in the array.`
no guarantee of a specific ordering of the elements in the array.
Arguments:
CATALOG_NAME: Parent catalog for schemas of interest.`
cmd.Annotations = make(map[string]string)
@ -372,7 +385,10 @@ func newUpdate() *cobra.Command {
a metastore admin. If the caller is a metastore admin, only the __owner__
field can be changed in the update. If the __name__ field must be updated, the
caller must be a metastore admin or have the **CREATE_SCHEMA** privilege on
the parent catalog.`
the parent catalog.
Arguments:
FULL_NAME: Full name of the schema.`
cmd.Annotations = make(map[string]string)

51
cmd/workspace/secrets/secrets.go generated
View File

@ -74,7 +74,10 @@ func newCreateScope() *cobra.Command {
The scope name must consist of alphanumeric characters, dashes, underscores,
and periods, and may not exceed 128 characters. The maximum number of scopes
in a workspace is 100.`
in a workspace is 100.
Arguments:
SCOPE: Scope name requested by the user. Scope names are unique.`
cmd.Annotations = make(map[string]string)
@ -157,7 +160,11 @@ func newDeleteAcl() *cobra.Command {
Users must have the MANAGE permission to invoke this API. Throws
RESOURCE_DOES_NOT_EXIST if no such secret scope, principal, or ACL exists.
Throws PERMISSION_DENIED if the user does not have permission to make this
API call.`
API call.
Arguments:
SCOPE: The name of the scope to remove permissions from.
PRINCIPAL: The principal to remove an existing ACL from.`
cmd.Annotations = make(map[string]string)
@ -242,7 +249,10 @@ func newDeleteScope() *cobra.Command {
Throws RESOURCE_DOES_NOT_EXIST if the scope does not exist. Throws
PERMISSION_DENIED if the user does not have permission to make this API
call.`
call.
Arguments:
SCOPE: Name of the scope to delete.`
cmd.Annotations = make(map[string]string)
@ -325,7 +335,11 @@ func newDeleteSecret() *cobra.Command {
Throws RESOURCE_DOES_NOT_EXIST if no such secret scope or secret exists.
Throws PERMISSION_DENIED if the user does not have permission to make this
API call.`
API call.
Arguments:
SCOPE: The name of the scope that contains the secret to delete.
KEY: Name of the secret to delete.`
cmd.Annotations = make(map[string]string)
@ -409,7 +423,11 @@ func newGetAcl() *cobra.Command {
Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws
PERMISSION_DENIED if the user does not have permission to make this API
call.`
call.
Arguments:
SCOPE: The name of the scope to fetch ACL information from.
PRINCIPAL: The principal to fetch ACL information for.`
cmd.Annotations = make(map[string]string)
@ -482,7 +500,11 @@ func newGetSecret() *cobra.Command {
Throws PERMISSION_DENIED if the user does not have permission to make this
API call. Throws RESOURCE_DOES_NOT_EXIST if no such secret or secret scope
exists.`
exists.
Arguments:
SCOPE: The name of the scope to fetch secret information from.
KEY: The key to fetch secret for.`
cmd.Annotations = make(map[string]string)
@ -549,7 +571,10 @@ func newListAcls() *cobra.Command {
Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws
PERMISSION_DENIED if the user does not have permission to make this API
call.`
call.
Arguments:
SCOPE: The name of the scope to fetch ACL information from.`
cmd.Annotations = make(map[string]string)
@ -668,7 +693,10 @@ func newListSecrets() *cobra.Command {
The lastUpdatedTimestamp returned is in milliseconds since epoch. Throws
RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws
PERMISSION_DENIED if the user does not have permission to make this API
call.`
call.
Arguments:
SCOPE: The name of the scope to list secrets within.`
cmd.Annotations = make(map[string]string)
@ -756,7 +784,12 @@ func newPutAcl() *cobra.Command {
RESOURCE_ALREADY_EXISTS if a permission for the principal already exists.
Throws INVALID_PARAMETER_VALUE if the permission or principal is invalid.
Throws PERMISSION_DENIED if the user does not have permission to make this
API call.`
API call.
Arguments:
SCOPE: The name of the scope to apply permissions to.
PRINCIPAL: The principal in which the permission is applied.
PERMISSION: The permission level applied to the principal.`
cmd.Annotations = make(map[string]string)

20
cmd/workspace/service-principals/service-principals.go generated
View File

@ -138,7 +138,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete a service principal.`
cmd.Long = `Delete a service principal.
Delete a single service principal in the Databricks workspace.`
Delete a single service principal in the Databricks workspace.
Arguments:
ID: Unique ID for a service principal in the Databricks workspace.`
cmd.Annotations = make(map[string]string)
@ -212,7 +215,10 @@ func newGet() *cobra.Command {
cmd.Long = `Get service principal details.
Gets the details for a single service principal define in the Databricks
workspace.`
workspace.
Arguments:
ID: Unique ID for a service principal in the Databricks workspace.`
cmd.Annotations = make(map[string]string)
@ -358,7 +364,10 @@ func newPatch() *cobra.Command {
cmd.Long = `Update service principal details.
Partially updates the details of a single service principal in the Databricks
workspace.`
workspace.
Arguments:
ID: Unique ID for a service principal in the Databricks workspace.`
cmd.Annotations = make(map[string]string)
@ -451,7 +460,10 @@ func newUpdate() *cobra.Command {
Updates the details of a single service principal.
This action replaces the existing service principal with the same name.`
This action replaces the existing service principal with the same name.
Arguments:
ID: Databricks service principal ID.`
cmd.Annotations = make(map[string]string)

63
cmd/workspace/serving-endpoints/serving-endpoints.go generated
View File

@ -69,7 +69,13 @@ func newBuildLogs() *cobra.Command {
cmd.Long = `Retrieve the logs associated with building the model's environment for a given
serving endpoint's served model.
Retrieves the build logs associated with the provided served model.`
Retrieves the build logs associated with the provided served model.
Arguments:
NAME: The name of the serving endpoint that the served model belongs to. This
field is required.
SERVED_MODEL_NAME: The name of the served model that build logs will be retrieved for. This
field is required.`
cmd.Annotations = make(map[string]string)
@ -212,7 +218,10 @@ func newDelete() *cobra.Command {
cmd.Use = "delete NAME"
cmd.Short = `Delete a serving endpoint.`
cmd.Long = `Delete a serving endpoint.`
cmd.Long = `Delete a serving endpoint.
Arguments:
NAME: The name of the serving endpoint. This field is required.`
cmd.Annotations = make(map[string]string)
@ -274,7 +283,11 @@ func newExportMetrics() *cobra.Command {
cmd.Long = `Retrieve the metrics associated with a serving endpoint.
Retrieves the metrics associated with the provided serving endpoint in either
Prometheus or OpenMetrics exposition format.`
Prometheus or OpenMetrics exposition format.
Arguments:
NAME: The name of the serving endpoint to retrieve metrics for. This field is
required.`
cmd.Annotations = make(map[string]string)
@ -335,7 +348,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get a single serving endpoint.`
cmd.Long = `Get a single serving endpoint.
Retrieves the details for a single serving endpoint.`
Retrieves the details for a single serving endpoint.
Arguments:
NAME: The name of the serving endpoint. This field is required.`
cmd.Annotations = make(map[string]string)
@ -396,7 +412,10 @@ func newGetPermissionLevels() *cobra.Command {
cmd.Short = `Get serving endpoint permission levels.`
cmd.Long = `Get serving endpoint permission levels.
Gets the permission levels that a user can have on an object.`
Gets the permission levels that a user can have on an object.
Arguments:
SERVING_ENDPOINT_ID: The serving endpoint for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -458,7 +477,10 @@ func newGetPermissions() *cobra.Command {
cmd.Long = `Get serving endpoint permissions.
Gets the permissions of a serving endpoint. Serving endpoints can inherit
permissions from their root object.`
permissions from their root object.
Arguments:
SERVING_ENDPOINT_ID: The serving endpoint for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -566,7 +588,13 @@ func newLogs() *cobra.Command {
cmd.Long = `Retrieve the most recent log lines associated with a given serving endpoint's
served model.
Retrieves the service logs associated with the provided served model.`
Retrieves the service logs associated with the provided served model.
Arguments:
NAME: The name of the serving endpoint that the served model belongs to. This
field is required.
SERVED_MODEL_NAME: The name of the served model that logs will be retrieved for. This field
is required.`
cmd.Annotations = make(map[string]string)
@ -634,7 +662,11 @@ func newPatch() *cobra.Command {
cmd.Long = `Patch the tags of a serving endpoint.
Used to batch add and delete tags from a serving endpoint with a single API
call.`
call.
Arguments:
NAME: The name of the serving endpoint who's tags to patch. This field is
required.`
cmd.Annotations = make(map[string]string)
@ -706,7 +738,10 @@ func newQuery() *cobra.Command {
cmd.Use = "query NAME"
cmd.Short = `Query a serving endpoint with provided model input.`
cmd.Long = `Query a serving endpoint with provided model input.`
cmd.Long = `Query a serving endpoint with provided model input.
Arguments:
NAME: The name of the serving endpoint. This field is required.`
cmd.Annotations = make(map[string]string)
@ -778,7 +813,10 @@ func newSetPermissions() *cobra.Command {
cmd.Long = `Set serving endpoint permissions.
Sets permissions on a serving endpoint. Serving endpoints can inherit
permissions from their root object.`
permissions from their root object.
Arguments:
SERVING_ENDPOINT_ID: The serving endpoint for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -938,7 +976,10 @@ func newUpdatePermissions() *cobra.Command {
cmd.Long = `Update serving endpoint permissions.
Updates the permissions on a serving endpoint. Serving endpoints can inherit
permissions from their root object.`
permissions from their root object.
Arguments:
SERVING_ENDPOINT_ID: The serving endpoint for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)

22
cmd/workspace/settings/settings.go generated
View File

@ -68,7 +68,16 @@ func newDeleteDefaultWorkspaceNamespace() *cobra.Command {
be provided in DELETE requests (as a query parameter). The etag can be
retrieved by making a GET request before the DELETE request. If the setting is
updated/deleted concurrently, DELETE will fail with 409 and the request will
need to be retried by using the fresh etag in the 409 response.`
need to be retried by using the fresh etag in the 409 response.
Arguments:
ETAG: etag used for versioning. The response is at least as fresh as the eTag
provided. This is used for optimistic concurrency control as a way to help
prevent simultaneous writes of a setting overwriting each other. It is
strongly suggested that systems make use of the etag in the read -> delete
pattern to perform setting deletions in order to avoid race conditions.
That is, get an etag from a GET request, and pass it with the DELETE
request to identify the rule set version you are deleting.`
cmd.Annotations = make(map[string]string)
@ -129,7 +138,16 @@ func newReadDefaultWorkspaceNamespace() *cobra.Command {
cmd.Short = `Get the default namespace setting.`
cmd.Long = `Get the default namespace setting.
Gets the default namespace setting.`
Gets the default namespace setting.
Arguments:
ETAG: etag used for versioning. The response is at least as fresh as the eTag
provided. This is used for optimistic concurrency control as a way to help
prevent simultaneous writes of a setting overwriting each other. It is
strongly suggested that systems make use of the etag in the read -> delete
pattern to perform setting deletions in order to avoid race conditions.
That is, get an etag from a GET request, and pass it with the DELETE
request to identify the rule set version you are deleting.`
cmd.Annotations = make(map[string]string)

30
cmd/workspace/shares/shares.go generated
View File

@ -65,7 +65,10 @@ func newCreate() *cobra.Command {
Creates a new share for data objects. Data objects can be added after creation
with **update**. The caller must be a metastore admin or have the
**CREATE_SHARE** privilege on the metastore.`
**CREATE_SHARE** privilege on the metastore.
Arguments:
NAME: Name of the share.`
cmd.Annotations = make(map[string]string)
@ -142,7 +145,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete a share.
Deletes a data object share from the metastore. The caller must be an owner of
the share.`
the share.
Arguments:
NAME: The name of the share.`
cmd.Annotations = make(map[string]string)
@ -206,7 +212,10 @@ func newGet() *cobra.Command {
cmd.Long = `Get a share.
Gets a data object share from the metastore. The caller must be a metastore
admin or the owner of the share.`
admin or the owner of the share.
Arguments:
NAME: The name of the share.`
cmd.Annotations = make(map[string]string)
@ -318,7 +327,10 @@ func newSharePermissions() *cobra.Command {
cmd.Long = `Get permissions.
Gets the permissions for a data share from the metastore. The caller must be a
metastore admin or the owner of the share.`
metastore admin or the owner of the share.
Arguments:
NAME: The name of the share.`
cmd.Annotations = make(map[string]string)
@ -399,7 +411,10 @@ func newUpdate() *cobra.Command {
indefinitely for recipients to be able to access the table. Typically, you
should use a group as the share owner.
Table removals through **update** do not require additional privileges.`
Table removals through **update** do not require additional privileges.
Arguments:
NAME: Name of the share.`
cmd.Annotations = make(map[string]string)
@ -474,7 +489,10 @@ func newUpdatePermissions() *cobra.Command {
a metastore admin or an owner of the share.
For new recipient grants, the user must also be the owner of the recipients.
recipient revocations do not require additional privileges.`
recipient revocations do not require additional privileges.
Arguments:
NAME: The name of the share.`
cmd.Annotations = make(map[string]string)

20
cmd/workspace/storage-credentials/storage-credentials.go generated
View File

@ -77,7 +77,10 @@ func newCreate() *cobra.Command {
cmd.Short = `Create a storage credential.`
cmd.Long = `Create a storage credential.
Creates a new storage credential.`
Creates a new storage credential.
Arguments:
NAME: The credential name. The name must be unique within the metastore.`
cmd.Annotations = make(map[string]string)
@ -156,7 +159,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete a credential.
Deletes a storage credential from the metastore. The caller must be an owner
of the storage credential.`
of the storage credential.
Arguments:
NAME: Name of the storage credential.`
cmd.Annotations = make(map[string]string)
@ -231,7 +237,10 @@ func newGet() *cobra.Command {
Gets a storage credential from the metastore. The caller must be a metastore
admin, the owner of the storage credential, or have some permission on the
storage credential.`
storage credential.
Arguments:
NAME: Name of the storage credential.`
cmd.Annotations = make(map[string]string)
@ -369,7 +378,10 @@ func newUpdate() *cobra.Command {
cmd.Short = `Update a credential.`
cmd.Long = `Update a credential.
Updates a storage credential on the metastore.`
Updates a storage credential on the metastore.
Arguments:
NAME: The credential name. The name must be unique within the metastore.`
cmd.Annotations = make(map[string]string)

17
cmd/workspace/system-schemas/system-schemas.go generated
View File

@ -57,7 +57,11 @@ func newDisable() *cobra.Command {
cmd.Long = `Disable a system schema.
Disables the system schema and removes it from the system catalog. The caller
must be an account admin or a metastore admin.`
must be an account admin or a metastore admin.
Arguments:
METASTORE_ID: The metastore ID under which the system schema lives.
SCHEMA_NAME: Full name of the system schema.`
cmd.Annotations = make(map[string]string)
@ -123,7 +127,11 @@ func newEnable() *cobra.Command {
cmd.Long = `Enable a system schema.
Enables the system schema and adds it to the system catalog. The caller must
be an account admin or a metastore admin.`
be an account admin or a metastore admin.
Arguments:
METASTORE_ID: The metastore ID under which the system schema lives.
SCHEMA_NAME: Full name of the system schema.`
cmd.Annotations = make(map[string]string)
@ -189,7 +197,10 @@ func newList() *cobra.Command {
cmd.Long = `List system schemas.
Gets an array of system schemas for a metastore. The caller must be an account
admin or a metastore admin.`
admin or a metastore admin.
Arguments:
METASTORE_ID: The ID for the metastore in which the system schema resides.`
cmd.Annotations = make(map[string]string)

9
cmd/workspace/table-constraints/table-constraints.go generated
View File

@ -149,7 +149,14 @@ func newDelete() *cobra.Command {
schema, and be the owner of the table. - if __cascade__ argument is **true**,
the user must have the following permissions on all of the child tables: the
**USE_CATALOG** privilege on the table's catalog, the **USE_SCHEMA** privilege
on the table's schema, and be the owner of the table.`
on the table's schema, and be the owner of the table.
Arguments:
FULL_NAME: Full name of the table referenced by the constraint.
CONSTRAINT_NAME: The name of the constraint to delete.
CASCADE: If true, try deleting all child constraints of the current constraint. If
false, reject this operation if the current constraint has any child
constraints.`
cmd.Annotations = make(map[string]string)

26
cmd/workspace/tables/tables.go generated
View File

@ -67,7 +67,10 @@ func newDelete() *cobra.Command {
be the owner of the parent catalog, have the **USE_CATALOG** privilege on the
parent catalog and be the owner of the parent schema, or be the owner of the
table and have the **USE_CATALOG** privilege on the parent catalog and the
**USE_SCHEMA** privilege on the parent schema.`
**USE_SCHEMA** privilege on the parent schema.
Arguments:
FULL_NAME: Full name of the table.`
cmd.Annotations = make(map[string]string)
@ -146,7 +149,10 @@ func newGet() *cobra.Command {
must be a metastore admin, be the owner of the table and have the
**USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA**
privilege on the parent schema, or be the owner of the table and have the
**SELECT** privilege on it as well.`
**SELECT** privilege on it as well.
Arguments:
FULL_NAME: Full name of the table.`
cmd.Annotations = make(map[string]string)
@ -228,7 +234,11 @@ func newList() *cobra.Command {
**SELECT** privilege on) the table. For the latter case, the caller must also
be the owner or have the **USE_CATALOG** privilege on the parent catalog and
the **USE_SCHEMA** privilege on the parent schema. There is no guarantee of a
specific ordering of the elements in the array.`
specific ordering of the elements in the array.
Arguments:
CATALOG_NAME: Name of parent catalog for tables of interest.
SCHEMA_NAME: Parent schema of tables.`
cmd.Annotations = make(map[string]string)
@ -305,7 +315,10 @@ func newListSummaries() *cobra.Command {
or **USE_SCHEMA** privilege on the schema, provided that the user also has
ownership or the **USE_CATALOG** privilege on the parent catalog.
There is no guarantee of a specific ordering of the elements in the array.`
There is no guarantee of a specific ordering of the elements in the array.
Arguments:
CATALOG_NAME: Name of parent catalog for tables of interest.`
cmd.Annotations = make(map[string]string)
@ -386,7 +399,10 @@ func newUpdate() *cobra.Command {
catalog, have the **USE_CATALOG** privilege on the parent catalog and be the
owner of the parent schema, or be the owner of the table and have the
**USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA**
privilege on the parent schema.`
privilege on the parent schema.
Arguments:
FULL_NAME: Full name of the table.`
// This command is being previewed; hide from help output.
cmd.Hidden = true

16
cmd/workspace/token-management/token-management.go generated
View File

@ -61,7 +61,11 @@ func newCreateOboToken() *cobra.Command {
cmd.Short = `Create on-behalf token.`
cmd.Long = `Create on-behalf token.
Creates a token on behalf of a service principal.`
Creates a token on behalf of a service principal.
Arguments:
APPLICATION_ID: Application ID of the service principal.
LIFETIME_SECONDS: The number of seconds before the token expires.`
cmd.Annotations = make(map[string]string)
@ -143,7 +147,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete a token.`
cmd.Long = `Delete a token.
Deletes a token, specified by its ID.`
Deletes a token, specified by its ID.
Arguments:
TOKEN_ID: The ID of the token to get.`
cmd.Annotations = make(map[string]string)
@ -216,7 +223,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get token info.`
cmd.Long = `Get token info.
Gets information about a token, specified by its ID.`
Gets information about a token, specified by its ID.
Arguments:
TOKEN_ID: The ID of the token to get.`
cmd.Annotations = make(map[string]string)

5
cmd/workspace/tokens/tokens.go generated
View File

@ -135,7 +135,10 @@ func newDelete() *cobra.Command {
Revokes an access token.
If a token with the specified ID is not valid, this call returns an error
**RESOURCE_DOES_NOT_EXIST**.`
**RESOURCE_DOES_NOT_EXIST**.
Arguments:
TOKEN_ID: The ID of the token to be revoked.`
cmd.Annotations = make(map[string]string)

21
cmd/workspace/users/users.go generated
View File

@ -147,7 +147,10 @@ func newDelete() *cobra.Command {
cmd.Long = `Delete a user.
Deletes a user. Deleting a user from a Databricks workspace also removes
objects associated with the user.`
objects associated with the user.
Arguments:
ID: Unique ID for a user in the Databricks workspace.`
cmd.Annotations = make(map[string]string)
@ -228,7 +231,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get user details.`
cmd.Long = `Get user details.
Gets information for a specific user in Databricks workspace.`
Gets information for a specific user in Databricks workspace.
Arguments:
ID: Unique ID for a user in the Databricks workspace.`
cmd.Annotations = make(map[string]string)
@ -471,7 +477,10 @@ func newPatch() *cobra.Command {
cmd.Long = `Update user details.
Partially updates a user resource by applying the supplied operations on
specific user attributes.`
specific user attributes.
Arguments:
ID: Unique ID for a user in the Databricks workspace.`
cmd.Annotations = make(map[string]string)
@ -635,7 +644,11 @@ func newUpdate() *cobra.Command {
cmd.Short = `Replace a user.`
cmd.Long = `Replace a user.
Replaces a user's information with the data supplied in request.`
Replaces a user's information with the data supplied in request.
Arguments:
ID: Databricks user ID. This is automatically set by Databricks. Any value
provided by the client will be ignored.`
cmd.Annotations = make(map[string]string)

29
cmd/workspace/volumes/volumes.go generated
View File

@ -84,7 +84,13 @@ func newCreate() *cobra.Command {
must have **CREATE EXTERNAL VOLUME** privilege on the external location. -
There are no other tables, nor volumes existing in the specified storage
location. - The specified storage location is not under the location of other
tables, nor volumes, or catalogs or schemas.`
tables, nor volumes, or catalogs or schemas.
Arguments:
CATALOG_NAME: The name of the catalog where the schema and the volume are
SCHEMA_NAME: The name of the schema where the volume is
NAME: The name of the volume
VOLUME_TYPE: `
cmd.Annotations = make(map[string]string)
@ -176,7 +182,10 @@ func newDelete() *cobra.Command {
The caller must be a metastore admin or an owner of the volume. For the latter
case, the caller must also be the owner or have the **USE_CATALOG** privilege
on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.`
on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
Arguments:
FULL_NAME_ARG: The three-level (fully qualified) name of the volume`
cmd.Annotations = make(map[string]string)
@ -259,7 +268,11 @@ func newList() *cobra.Command {
also be the owner or have the **USE_CATALOG** privilege on the parent catalog
and the **USE_SCHEMA** privilege on the parent schema.
There is no guarantee of a specific ordering of the elements in the array.`
There is no guarantee of a specific ordering of the elements in the array.
Arguments:
CATALOG_NAME: The identifier of the catalog
SCHEMA_NAME: The identifier of the schema`
// This command is being previewed; hide from help output.
cmd.Hidden = true
@ -329,7 +342,10 @@ func newRead() *cobra.Command {
The caller must be a metastore admin or an owner of (or have the **READ
VOLUME** privilege on) the volume. For the latter case, the caller must also
be the owner or have the **USE_CATALOG** privilege on the parent catalog and
the **USE_SCHEMA** privilege on the parent schema.`
the **USE_SCHEMA** privilege on the parent schema.
Arguments:
FULL_NAME_ARG: The three-level (fully qualified) name of the volume`
cmd.Annotations = make(map[string]string)
@ -415,7 +431,10 @@ func newUpdate() *cobra.Command {
on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
Currently only the name, the owner or the comment of the volume could be
updated.`
updated.
Arguments:
FULL_NAME_ARG: The three-level (fully qualified) name of the volume`
cmd.Annotations = make(map[string]string)

45
cmd/workspace/warehouses/warehouses.go generated
View File

@ -164,7 +164,10 @@ func newDelete() *cobra.Command {
cmd.Short = `Delete a warehouse.`
cmd.Long = `Delete a warehouse.
Deletes a SQL warehouse.`
Deletes a SQL warehouse.
Arguments:
ID: Required. Id of the SQL warehouse.`
cmd.Annotations = make(map[string]string)
@ -258,7 +261,10 @@ func newEdit() *cobra.Command {
cmd.Short = `Update a warehouse.`
cmd.Long = `Update a warehouse.
Updates the configuration for a SQL warehouse.`
Updates the configuration for a SQL warehouse.
Arguments:
ID: Required. Id of the warehouse to configure.`
cmd.Annotations = make(map[string]string)
@ -361,7 +367,10 @@ func newGet() *cobra.Command {
cmd.Short = `Get warehouse info.`
cmd.Long = `Get warehouse info.
Gets the information for a single SQL warehouse.`
Gets the information for a single SQL warehouse.
Arguments:
ID: Required. Id of the SQL warehouse.`
cmd.Annotations = make(map[string]string)
@ -434,7 +443,10 @@ func newGetPermissionLevels() *cobra.Command {
cmd.Short = `Get SQL warehouse permission levels.`
cmd.Long = `Get SQL warehouse permission levels.
Gets the permission levels that a user can have on an object.`
Gets the permission levels that a user can have on an object.
Arguments:
WAREHOUSE_ID: The SQL warehouse for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -508,7 +520,10 @@ func newGetPermissions() *cobra.Command {
cmd.Long = `Get SQL warehouse permissions.
Gets the permissions of a SQL warehouse. SQL warehouses can inherit
permissions from their root object.`
permissions from their root object.
Arguments:
WAREHOUSE_ID: The SQL warehouse for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -696,7 +711,10 @@ func newSetPermissions() *cobra.Command {
cmd.Long = `Set SQL warehouse permissions.
Sets permissions on a SQL warehouse. SQL warehouses can inherit permissions
from their root object.`
from their root object.
Arguments:
WAREHOUSE_ID: The SQL warehouse for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -859,7 +877,10 @@ func newStart() *cobra.Command {
cmd.Short = `Start a warehouse.`
cmd.Long = `Start a warehouse.
Starts a SQL warehouse.`
Starts a SQL warehouse.
Arguments:
ID: Required. Id of the SQL warehouse.`
cmd.Annotations = make(map[string]string)
@ -956,7 +977,10 @@ func newStop() *cobra.Command {
cmd.Short = `Stop a warehouse.`
cmd.Long = `Stop a warehouse.
Stops a SQL warehouse.`
Stops a SQL warehouse.
Arguments:
ID: Required. Id of the SQL warehouse.`
cmd.Annotations = make(map[string]string)
@ -1053,7 +1077,10 @@ func newUpdatePermissions() *cobra.Command {
cmd.Long = `Update SQL warehouse permissions.
Updates the permissions on a SQL warehouse. SQL warehouses can inherit
permissions from their root object.`
permissions from their root object.
Arguments:
WAREHOUSE_ID: The SQL warehouse for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)

22
cmd/workspace/workspace-bindings/workspace-bindings.go generated
View File

@ -71,7 +71,10 @@ func newGet() *cobra.Command {
cmd.Long = `Get catalog workspace bindings.
Gets workspace bindings of the catalog. The caller must be a metastore admin
or an owner of the catalog.`
or an owner of the catalog.
Arguments:
NAME: The name of the catalog.`
cmd.Annotations = make(map[string]string)
@ -133,7 +136,11 @@ func newGetBindings() *cobra.Command {
cmd.Long = `Get securable workspace bindings.
Gets workspace bindings of the securable. The caller must be a metastore admin
or an owner of the securable.`
or an owner of the securable.
Arguments:
SECURABLE_TYPE: The type of the securable.
SECURABLE_NAME: The name of the securable.`
cmd.Annotations = make(map[string]string)
@ -201,7 +208,10 @@ func newUpdate() *cobra.Command {
cmd.Long = `Update catalog workspace bindings.
Updates workspace bindings of the catalog. The caller must be a metastore
admin or an owner of the catalog.`
admin or an owner of the catalog.
Arguments:
NAME: The name of the catalog.`
cmd.Annotations = make(map[string]string)
@ -274,7 +284,11 @@ func newUpdateBindings() *cobra.Command {
cmd.Long = `Update securable workspace bindings.
Updates workspace bindings of the securable. The caller must be a metastore
admin or an owner of the securable.`
admin or an owner of the securable.
Arguments:
SECURABLE_TYPE: The type of the securable.
SECURABLE_NAME: The name of the securable.`
cmd.Annotations = make(map[string]string)

58
cmd/workspace/workspace/workspace.go generated
View File

@ -70,7 +70,10 @@ func newDelete() *cobra.Command {
DIRECTORY_NOT_EMPTY.
Object deletion cannot be undone and deleting a directory recursively is not
atomic.`
atomic.
Arguments:
PATH: The absolute path of the notebook or directory.`
cmd.Annotations = make(map[string]string)
@ -159,7 +162,11 @@ func newExport() *cobra.Command {
If the exported data would exceed size limit, this call returns
MAX_NOTEBOOK_SIZE_EXCEEDED. Currently, this API does not support exporting a
library.`
library.
Arguments:
PATH: The absolute path of the object or directory. Exporting a directory is
only supported for the DBC, SOURCE, and AUTO format.`
cmd.Annotations = make(map[string]string)
@ -232,7 +239,11 @@ func newGetPermissionLevels() *cobra.Command {
cmd.Short = `Get workspace object permission levels.`
cmd.Long = `Get workspace object permission levels.
Gets the permission levels that a user can have on an object.`
Gets the permission levels that a user can have on an object.
Arguments:
WORKSPACE_OBJECT_TYPE: The workspace object type for which to get or manage permissions.
WORKSPACE_OBJECT_ID: The workspace object for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -295,7 +306,11 @@ func newGetPermissions() *cobra.Command {
cmd.Long = `Get workspace object permissions.
Gets the permissions of a workspace object. Workspace objects can inherit
permissions from their parent objects or root object.`
permissions from their parent objects or root object.
Arguments:
WORKSPACE_OBJECT_TYPE: The workspace object type for which to get or manage permissions.
WORKSPACE_OBJECT_ID: The workspace object for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -358,7 +373,10 @@ func newGetStatus() *cobra.Command {
cmd.Long = `Get status.
Gets the status of an object or a directory. If path does not exist, this
call returns an error RESOURCE_DOES_NOT_EXIST.`
call returns an error RESOURCE_DOES_NOT_EXIST.
Arguments:
PATH: The absolute path of the notebook or directory.`
cmd.Annotations = make(map[string]string)
@ -431,7 +449,11 @@ func newImport() *cobra.Command {
false, this call returns an error RESOURCE_ALREADY_EXISTS. To import a
directory, you can use either the DBC format or the SOURCE format with the
language field unset. To import a single file as SOURCE, you must set the
language field.`
language field.
Arguments:
PATH: The absolute path of the object or directory. Importing a directory is
only supported for the DBC and SOURCE formats.`
cmd.Annotations = make(map[string]string)
@ -511,7 +533,10 @@ func newList() *cobra.Command {
Lists the contents of a directory, or the object if it is not a directory. If
the input path does not exist, this call returns an error
RESOURCE_DOES_NOT_EXIST.`
RESOURCE_DOES_NOT_EXIST.
Arguments:
PATH: The absolute path of the notebook or directory.`
cmd.Annotations = make(map[string]string)
@ -579,7 +604,12 @@ func newMkdirs() *cobra.Command {
path, this call returns an error RESOURCE_ALREADY_EXISTS.
Note that if this operation fails it may have succeeded in creating some of
the necessary parent directories.`
the necessary parent directories.
Arguments:
PATH: The absolute path of the directory. If the parent directories do not
exist, it will also create them. If the directory already exists, this
command will do nothing and succeed.`
cmd.Annotations = make(map[string]string)
@ -664,7 +694,11 @@ func newSetPermissions() *cobra.Command {
cmd.Long = `Set workspace object permissions.
Sets permissions on a workspace object. Workspace objects can inherit
permissions from their parent objects or root object.`
permissions from their parent objects or root object.
Arguments:
WORKSPACE_OBJECT_TYPE: The workspace object type for which to get or manage permissions.
WORKSPACE_OBJECT_ID: The workspace object for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)
@ -737,7 +771,11 @@ func newUpdatePermissions() *cobra.Command {
cmd.Long = `Update workspace object permissions.
Updates the permissions on a workspace object. Workspace objects can inherit
permissions from their parent objects or root object.`
permissions from their parent objects or root object.
Arguments:
WORKSPACE_OBJECT_TYPE: The workspace object type for which to get or manage permissions.
WORKSPACE_OBJECT_ID: The workspace object for which to get or manage permissions.`
cmd.Annotations = make(map[string]string)