update-api

Author: renaudhartert-db

.codegen/_openapi_sha

@@ -1 +1 @@
-07d1b7f422d74bd84d82bf4557427f1308158396
+95e08d8bc631ac93d68e3846aea3cb04a2913495

docs/account/billing/billable_usage.rst

@@ -20,8 +20,6 @@
             
             resp = a.billable_usage.download(start_month="2024-08", end_month="2024-09")
 
-        Return billable usage logs.
-
         Returns billable usage logs in CSV format for the specified account and date range. For the data
         schema, see [CSV file schema]. Note that this method might take multiple minutes to complete.
 

docs/account/billing/budget_policy.rst

@@ -8,8 +8,6 @@
 
     .. py:method:: create( [, policy: Optional[BudgetPolicy], request_id: Optional[str]]) -> BudgetPolicy
 
-        Create a budget policy.
-
         Creates a new policy.
 
         :param policy: :class:`BudgetPolicy` (optional)
@@ -25,8 +23,6 @@
 
     .. py:method:: delete(policy_id: str)
 
-        Delete a budget policy.
-
         Deletes a policy
 
         :param policy_id: str
@@ -37,8 +33,6 @@
 
     .. py:method:: get(policy_id: str) -> BudgetPolicy
 
-        Get a budget policy.
-
         Retrieves a policy by it's ID.
 
         :param policy_id: str
@@ -49,8 +43,6 @@
 
     .. py:method:: list( [, filter_by: Optional[Filter], page_size: Optional[int], page_token: Optional[str], sort_spec: Optional[SortSpec]]) -> Iterator[BudgetPolicy]
 
-        List policies.
-
         Lists all policies. Policies are returned in the alphabetically ascending order of their names.
 
         :param filter_by: :class:`Filter` (optional)
@@ -72,8 +64,6 @@
 
     .. py:method:: update(policy_id: str, policy: BudgetPolicy [, limit_config: Optional[LimitConfig]]) -> BudgetPolicy
 
-        Update a budget policy.
-
         Updates a policy
 
         :param policy_id: str

docs/account/billing/budgets.rst

@@ -56,8 +56,6 @@
             # cleanup
             a.budgets.delete(budget_id=created.budget.budget_configuration_id)
 
-        Create new budget.
-
         Create a new budget configuration for an account. For full details, see
         https://docs.databricks.com/en/admin/account-settings/budgets.html.
 
@@ -69,8 +67,6 @@
 
     .. py:method:: delete(budget_id: str)
 
-        Delete budget.
-
         Deletes a budget configuration for an account. Both account and budget configuration are specified by
         ID. This cannot be undone.
 
@@ -130,8 +126,6 @@
             # cleanup
             a.budgets.delete(budget_id=created.budget.budget_configuration_id)
 
-        Get budget.
-
         Gets a budget configuration for an account. Both account and budget configuration are specified by ID.
 
         :param budget_id: str
@@ -154,8 +148,6 @@
             
             all = a.budgets.list(billing.ListBudgetConfigurationsRequest())
 
-        Get all budgets.
-
         Gets all budgets associated with this account.
 
         :param page_token: str (optional)
@@ -242,8 +234,6 @@
             # cleanup
             a.budgets.delete(budget_id=created.budget.budget_configuration_id)
 
-        Modify budget.
-
         Updates a budget configuration for an account. Both account and budget configuration are specified by
         ID.
 

docs/account/billing/log_delivery.rst

@@ -52,8 +52,6 @@
                 status=billing.LogDeliveryConfigStatus.DISABLED,
             )
 
-        Create a new log delivery configuration.
-
         Creates a new Databricks log delivery configuration to enable delivery of the specified type of logs
         to your storage location. This requires that you already created a [credential
         object](:method:Credentials/Create) (which encapsulates a cross-account service IAM role) and a
@@ -128,8 +126,6 @@
                 status=billing.LogDeliveryConfigStatus.DISABLED,
             )
 
-        Get log delivery configuration.
-
         Gets a Databricks log delivery configuration object for an account, both specified by ID.
 
         :param log_delivery_configuration_id: str
@@ -152,8 +148,6 @@
             
             all = a.log_delivery.list(billing.ListLogDeliveryRequest())
 
-        Get all log delivery configurations.
-
         Gets all Databricks log delivery configurations associated with an account specified by ID.
 
         :param credentials_id: str (optional)
@@ -171,8 +165,6 @@
 
     .. py:method:: patch_status(log_delivery_configuration_id: str, status: LogDeliveryConfigStatus)
 
-        Enable or disable log delivery configuration.
-
         Enables or disables a log delivery configuration. Deletion of delivery 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

docs/account/billing/usage_dashboards.rst

@@ -10,8 +10,6 @@
 
     .. py:method:: create( [, dashboard_type: Optional[UsageDashboardType], workspace_id: Optional[int]]) -> CreateBillingUsageDashboardResponse
 
-        Create new usage dashboard.
-
         Create a usage dashboard specified by workspaceId, accountId, and dashboard type.
 
         :param dashboard_type: :class:`UsageDashboardType` (optional)
@@ -25,8 +23,6 @@
 
     .. py:method:: get( [, dashboard_type: Optional[UsageDashboardType], workspace_id: Optional[int]]) -> GetBillingUsageDashboardResponse
 
-        Get usage dashboard.
-
         Get a usage dashboard specified by workspaceId, accountId, and dashboard type.
 
         :param dashboard_type: :class:`UsageDashboardType` (optional)

docs/account/catalog/metastore_assignments.rst

@@ -8,8 +8,6 @@
 
     .. py:method:: create(workspace_id: int, metastore_id: str [, metastore_assignment: Optional[CreateMetastoreAssignment]])
 
-        Assigns a workspace to a metastore.
-
         Creates an assignment to a metastore for a workspace
 
         :param workspace_id: int
@@ -23,8 +21,6 @@
 
     .. py:method:: delete(workspace_id: int, metastore_id: str)
 
-        Delete a metastore assignment.
-
         Deletes a metastore assignment to a workspace, leaving the workspace with no metastore.
 
         :param workspace_id: int
@@ -37,8 +33,6 @@
 
     .. py:method:: get(workspace_id: int) -> AccountsMetastoreAssignment
 
-        Gets the metastore assignment for a workspace.
-
         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.
@@ -64,8 +58,6 @@
             
             ws = a.metastore_assignments.list(metastore_id=os.environ["TEST_METASTORE_ID"])
 
-        Get all workspaces assigned to a metastore.
-
         Gets a list of all Databricks workspace IDs that have been assigned to given metastore.
 
         :param metastore_id: str
@@ -76,8 +68,6 @@
 
     .. py:method:: update(workspace_id: int, metastore_id: str [, metastore_assignment: Optional[UpdateMetastoreAssignment]])
 
-        Updates a metastore assignment to a workspaces.
-
         Updates an assignment to a metastore for a workspace. Currently, only the default catalog may be
         updated.
 

docs/account/catalog/metastores.rst

@@ -9,8 +9,6 @@
 
     .. py:method:: create( [, metastore_info: Optional[CreateMetastore]]) -> AccountsMetastoreInfo
 
-        Create metastore.
-
         Creates a Unity Catalog metastore.
 
         :param metastore_info: :class:`CreateMetastore` (optional)
@@ -20,8 +18,6 @@
 
     .. py:method:: delete(metastore_id: str [, force: Optional[bool]])
 
-        Delete a metastore.
-
         Deletes a Unity Catalog metastore for an account, both specified by ID.
 
         :param metastore_id: str
@@ -34,8 +30,6 @@
 
     .. py:method:: get(metastore_id: str) -> AccountsMetastoreInfo
 
-        Get a metastore.
-
         Gets a Unity Catalog metastore from an account, both specified by ID.
 
         :param metastore_id: str
@@ -46,17 +40,13 @@
 
     .. py:method:: list() -> Iterator[MetastoreInfo]
 
-        Get all metastores associated with an account.
-
         Gets all Unity Catalog metastores associated with an account specified by ID.
 
         :returns: Iterator over :class:`MetastoreInfo`
 
 
     .. py:method:: update(metastore_id: str [, metastore_info: Optional[UpdateMetastore]]) -> AccountsMetastoreInfo
 
-        Update a metastore.
-
         Updates an existing Unity Catalog metastore.
 
         :param metastore_id: str

docs/account/catalog/storage_credentials.rst

@@ -8,8 +8,6 @@
 
     .. py:method:: create(metastore_id: str [, credential_info: Optional[CreateStorageCredential]]) -> AccountsStorageCredentialInfo
 
-        Create a storage credential.
-
         Creates a new storage credential. The request object is specific to the cloud:
 
         * **AwsIamRole** for AWS credentials * **AzureServicePrincipal** for Azure credentials *
@@ -27,8 +25,6 @@
 
     .. py:method:: delete(metastore_id: str, storage_credential_name: str [, force: Optional[bool]])
 
-        Delete a storage credential.
-
         Deletes a storage credential from the metastore. The caller must be an owner of the storage
         credential.
 
@@ -44,8 +40,6 @@
 
     .. py:method:: get(metastore_id: str, storage_credential_name: str) -> AccountsStorageCredentialInfo
 
-        Gets the named storage credential.
-
         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.
 
@@ -59,8 +53,6 @@
 
     .. py:method:: list(metastore_id: str) -> Iterator[StorageCredentialInfo]
 
-        Get all storage credentials assigned to a metastore.
-
         Gets a list of all storage credentials that have been assigned to given metastore.
 
         :param metastore_id: str
@@ -71,8 +63,6 @@
 
     .. py:method:: update(metastore_id: str, storage_credential_name: str [, credential_info: Optional[UpdateStorageCredential]]) -> AccountsStorageCredentialInfo
 
-        Updates a storage credential.
-
         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.
 

docs/account/iam/access_control.rst

@@ -10,8 +10,6 @@
 
     .. py:method:: get_assignable_roles_for_resource(resource: str) -> GetAssignableRolesForResourceResponse
 
-        Get assignable roles for a resource.
-
         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.
 
@@ -28,8 +26,6 @@
 
     .. py:method:: get_rule_set(name: str, etag: str) -> RuleSetResponse
 
-        Get a rule set.
-
         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.
 
@@ -58,8 +54,6 @@
 
     .. py:method:: update_rule_set(name: str, rule_set: RuleSetUpdateRequest) -> RuleSetResponse
 
-        Update a rule set.
-
         Replace the rules of a rule set. First, use get to read the current version of the rule set before
         modifying it. This pattern helps prevent conflicts between concurrent updates.