databricks-sdk 0.56.0__py3-none-any.whl → 0.57.0__py3-none-any.whl

databricks/sdk/service/iam.py

@@ -2163,9 +2163,7 @@ class AccountAccessControlAPI:
         self._api = api_client
 
     def get_assignable_roles_for_resource(self, 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
+        """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.
 
         :param resource: str
@@ -2195,9 +2193,7 @@ class AccountAccessControlAPI:
         return GetAssignableRolesForResourceResponse.from_dict(res)
 
     def get_rule_set(self, 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
+        """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.
 
         :param name: str
@@ -2241,9 +2237,7 @@ class AccountAccessControlAPI:
         return RuleSetResponse.from_dict(res)
 
     def update_rule_set(self, 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
+        """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.
 
         :param name: str
@@ -2280,9 +2274,7 @@ class AccountAccessControlProxyAPI:
         self._api = api_client
 
     def get_assignable_roles_for_resource(self, 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
+        """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.
 
         :param resource: str
@@ -2309,9 +2301,7 @@ class AccountAccessControlProxyAPI:
         return GetAssignableRolesForResourceResponse.from_dict(res)
 
     def get_rule_set(self, 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
+        """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.
 
         :param name: str
@@ -2350,9 +2340,7 @@ class AccountAccessControlProxyAPI:
         return RuleSetResponse.from_dict(res)
 
     def update_rule_set(self, 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
+        """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.
 
         :param name: str
@@ -2399,9 +2387,7 @@ class AccountGroupsAPI:
         roles: Optional[List[ComplexValue]] = None,
         schemas: Optional[List[GroupSchema]] = None,
     ) -> Group:
-        """Create a new group.
-
-        Creates a group in the Databricks account with a unique name, using the supplied group details.
+        """Creates a group in the Databricks account with a unique name, using the supplied group details.
 
         :param display_name: str (optional)
           String that represents a human-readable group name
@@ -2454,9 +2440,7 @@ class AccountGroupsAPI:
         return Group.from_dict(res)
 
     def delete(self, id: str):
-        """Delete a group.
-
-        Deletes a group from the Databricks account.
+        """Deletes a group from the Databricks account.
 
         :param id: str
           Unique ID for a group in the Databricks account.
@@ -2469,9 +2453,7 @@ class AccountGroupsAPI:
         self._api.do("DELETE", f"/api/2.0/accounts/{self._api.account_id}/scim/v2/Groups/{id}", headers=headers)
 
     def get(self, id: str) -> Group:
-        """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.
 
         :param id: str
           Unique ID for a group in the Databricks account.
@@ -2497,9 +2479,7 @@ class AccountGroupsAPI:
         sort_order: Optional[ListSortOrder] = None,
         start_index: Optional[int] = None,
     ) -> Iterator[Group]:
-        """List group details.
-
-        Gets all details of the groups associated with the Databricks account.
+        """Gets all details of the groups associated with the Databricks account.
 
         :param attributes: str (optional)
           Comma-separated list of attributes to return in response.
@@ -2564,9 +2544,7 @@ class AccountGroupsAPI:
             query["startIndex"] += len(json["Resources"])
 
     def patch(self, id: str, *, operations: Optional[List[Patch]] = None, schemas: Optional[List[PatchSchema]] = None):
-        """Update group details.
-
-        Partially updates the details of a group.
+        """Partially updates the details of a group.
 
         :param id: str
           Unique ID in the Databricks workspace.
@@ -2602,9 +2580,7 @@ class AccountGroupsAPI:
         roles: Optional[List[ComplexValue]] = None,
         schemas: Optional[List[GroupSchema]] = None,
     ):
-        """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.
 
         :param id: str
           Databricks group ID
@@ -2674,9 +2650,7 @@ class AccountServicePrincipalsAPI:
         roles: Optional[List[ComplexValue]] = None,
         schemas: Optional[List[ServicePrincipalSchema]] = None,
     ) -> ServicePrincipal:
-        """Create a service principal.
-
-        Creates a new service principal in the Databricks account.
+        """Creates a new service principal in the Databricks account.
 
         :param active: bool (optional)
           If this user is active
@@ -2730,9 +2704,7 @@ class AccountServicePrincipalsAPI:
         return ServicePrincipal.from_dict(res)
 
     def delete(self, id: str):
-        """Delete a service principal.
-
-        Delete a single service principal in the Databricks account.
+        """Delete a single service principal in the Databricks account.
 
         :param id: str
           Unique ID for a service principal in the Databricks account.
@@ -2747,9 +2719,7 @@ class AccountServicePrincipalsAPI:
         )
 
     def get(self, id: str) -> ServicePrincipal:
-        """Get service principal details.
-
-        Gets the details for a single service principal define in the Databricks account.
+        """Gets the details for a single service principal define in the Databricks account.
 
         :param id: str
           Unique ID for a service principal in the Databricks account.
@@ -2777,9 +2747,7 @@ class AccountServicePrincipalsAPI:
         sort_order: Optional[ListSortOrder] = None,
         start_index: Optional[int] = None,
     ) -> Iterator[ServicePrincipal]:
-        """List service principals.
-
-        Gets the set of service principals associated with a Databricks account.
+        """Gets the set of service principals associated with a Databricks account.
 
         :param attributes: str (optional)
           Comma-separated list of attributes to return in response.
@@ -2847,9 +2815,7 @@ class AccountServicePrincipalsAPI:
             query["startIndex"] += len(json["Resources"])
 
     def patch(self, id: str, *, operations: Optional[List[Patch]] = None, schemas: Optional[List[PatchSchema]] = None):
-        """Update service principal details.
-
-        Partially updates the details of a single service principal in the Databricks account.
+        """Partially updates the details of a single service principal in the Databricks account.
 
         :param id: str
           Unique ID in the Databricks workspace.
@@ -2888,9 +2854,7 @@ class AccountServicePrincipalsAPI:
         roles: Optional[List[ComplexValue]] = None,
         schemas: Optional[List[ServicePrincipalSchema]] = None,
     ):
-        """Replace service principal.
-
-        Updates the details of a single service principal.
+        """Updates the details of a single service principal.
 
         This action replaces the existing service principal with the same name.
 
@@ -2974,9 +2938,7 @@ class AccountUsersAPI:
         schemas: Optional[List[UserSchema]] = None,
         user_name: Optional[str] = None,
     ) -> User:
-        """Create a new user.
-
-        Creates a new user in the Databricks account. This new user will also be added to the Databricks
+        """Creates a new user in the Databricks account. This new user will also be added to the Databricks
         account.
 
         :param active: bool (optional)
@@ -3042,9 +3004,7 @@ class AccountUsersAPI:
         return User.from_dict(res)
 
     def delete(self, id: str):
-        """Delete a user.
-
-        Deletes a user. Deleting a user from a Databricks account also removes objects associated with the
+        """Deletes a user. Deleting a user from a Databricks account also removes objects associated with the
         user.
 
         :param id: str
@@ -3069,9 +3029,7 @@ class AccountUsersAPI:
         sort_order: Optional[GetSortOrder] = None,
         start_index: Optional[int] = None,
     ) -> User:
-        """Get user details.
-
-        Gets information for a specific user in Databricks account.
+        """Gets information for a specific user in Databricks account.
 
         :param id: str
           Unique ID for a user in the Databricks account.
@@ -3134,9 +3092,7 @@ class AccountUsersAPI:
         sort_order: Optional[ListSortOrder] = None,
         start_index: Optional[int] = None,
     ) -> Iterator[User]:
-        """List users.
-
-        Gets details for all the users associated with a Databricks account.
+        """Gets details for all the users associated with a Databricks account.
 
         :param attributes: str (optional)
           Comma-separated list of attributes to return in response.
@@ -3202,9 +3158,7 @@ class AccountUsersAPI:
             query["startIndex"] += len(json["Resources"])
 
     def patch(self, id: str, *, operations: Optional[List[Patch]] = None, schemas: Optional[List[PatchSchema]] = None):
-        """Update user details.
-
-        Partially updates a user resource by applying the supplied operations on specific user attributes.
+        """Partially updates a user resource by applying the supplied operations on specific user attributes.
 
         :param id: str
           Unique ID in the Databricks workspace.
@@ -3242,9 +3196,7 @@ class AccountUsersAPI:
         schemas: Optional[List[UserSchema]] = None,
         user_name: Optional[str] = None,
     ):
-        """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.
 
         :param id: str
           Databricks user ID.
@@ -3310,9 +3262,7 @@ class CurrentUserAPI:
         self._api = api_client
 
     def me(self) -> User:
-        """Get current user info.
-
-        Get details about the current method caller's identity.
+        """Get details about the current method caller's identity.
 
         :returns: :class:`User`
         """
@@ -3349,9 +3299,7 @@ class GroupsAPI:
         roles: Optional[List[ComplexValue]] = None,
         schemas: Optional[List[GroupSchema]] = None,
     ) -> Group:
-        """Create a new group.
-
-        Creates a group in the Databricks workspace with a unique name, using the supplied group details.
+        """Creates a group in the Databricks workspace with a unique name, using the supplied group details.
 
         :param display_name: str (optional)
           String that represents a human-readable group name
@@ -3402,9 +3350,7 @@ class GroupsAPI:
         return Group.from_dict(res)
 
     def delete(self, id: str):
-        """Delete a group.
-
-        Deletes a group from the Databricks workspace.
+        """Deletes a group from the Databricks workspace.
 
         :param id: str
           Unique ID for a group in the Databricks workspace.
@@ -3417,9 +3363,7 @@ class GroupsAPI:
         self._api.do("DELETE", f"/api/2.0/preview/scim/v2/Groups/{id}", headers=headers)
 
     def get(self, id: str) -> Group:
-        """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.
 
         :param id: str
           Unique ID for a group in the Databricks workspace.
@@ -3445,9 +3389,7 @@ class GroupsAPI:
         sort_order: Optional[ListSortOrder] = None,
         start_index: Optional[int] = None,
     ) -> Iterator[Group]:
-        """List group details.
-
-        Gets all details of the groups associated with the Databricks workspace.
+        """Gets all details of the groups associated with the Databricks workspace.
 
         :param attributes: str (optional)
           Comma-separated list of attributes to return in response.
@@ -3510,9 +3452,7 @@ class GroupsAPI:
             query["startIndex"] += len(json["Resources"])
 
     def patch(self, id: str, *, operations: Optional[List[Patch]] = None, schemas: Optional[List[PatchSchema]] = None):
-        """Update group details.
-
-        Partially updates the details of a group.
+        """Partially updates the details of a group.
 
         :param id: str
           Unique ID in the Databricks workspace.
@@ -3546,9 +3486,7 @@ class GroupsAPI:
         roles: Optional[List[ComplexValue]] = None,
         schemas: Optional[List[GroupSchema]] = None,
     ):
-        """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.
 
         :param id: str
           Databricks group ID
@@ -3668,9 +3606,7 @@ class PermissionsAPI:
         self._api = api_client
 
     def get(self, request_object_type: str, request_object_id: str) -> ObjectPermissions:
-        """Get object permissions.
-
-        Gets the permissions of an object. Objects can inherit permissions from their parent objects or root
+        """Gets the permissions of an object. Objects can inherit permissions from their parent objects or root
         object.
 
         :param request_object_type: str
@@ -3691,9 +3627,7 @@ class PermissionsAPI:
         return ObjectPermissions.from_dict(res)
 
     def get_permission_levels(self, request_object_type: str, request_object_id: str) -> GetPermissionLevelsResponse:
-        """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.
 
         :param request_object_type: str
           The type of the request object. Can be one of the following: alerts, authorization, clusters,
@@ -3720,9 +3654,7 @@ class PermissionsAPI:
         *,
         access_control_list: Optional[List[AccessControlRequest]] = None,
     ) -> ObjectPermissions:
-        """Set object permissions.
-
-        Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
+        """Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
         permissions if none are specified. Objects can inherit permissions from their parent objects or root
         object.
 
@@ -3756,9 +3688,7 @@ class PermissionsAPI:
         *,
         access_control_list: Optional[List[AccessControlRequest]] = None,
     ) -> ObjectPermissions:
-        """Update object permissions.
-
-        Updates the permissions on an object. Objects can inherit permissions from their parent objects or
+        """Updates the permissions on an object. Objects can inherit permissions from their parent objects or
         root object.
 
         :param request_object_type: str
@@ -3808,9 +3738,7 @@ class ServicePrincipalsAPI:
         roles: Optional[List[ComplexValue]] = None,
         schemas: Optional[List[ServicePrincipalSchema]] = None,
     ) -> ServicePrincipal:
-        """Create a service principal.
-
-        Creates a new service principal in the Databricks workspace.
+        """Creates a new service principal in the Databricks workspace.
 
         :param active: bool (optional)
           If this user is active
@@ -3862,9 +3790,7 @@ class ServicePrincipalsAPI:
         return ServicePrincipal.from_dict(res)
 
     def delete(self, id: str):
-        """Delete a service principal.
-
-        Delete a single service principal in the Databricks workspace.
+        """Delete a single service principal in the Databricks workspace.
 
         :param id: str
           Unique ID for a service principal in the Databricks workspace.
@@ -3877,9 +3803,7 @@ class ServicePrincipalsAPI:
         self._api.do("DELETE", f"/api/2.0/preview/scim/v2/ServicePrincipals/{id}", headers=headers)
 
     def get(self, id: str) -> ServicePrincipal:
-        """Get service principal details.
-
-        Gets the details for a single service principal define in the Databricks workspace.
+        """Gets the details for a single service principal define in the Databricks workspace.
 
         :param id: str
           Unique ID for a service principal in the Databricks workspace.
@@ -3905,9 +3829,7 @@ class ServicePrincipalsAPI:
         sort_order: Optional[ListSortOrder] = None,
         start_index: Optional[int] = None,
     ) -> Iterator[ServicePrincipal]:
-        """List service principals.
-
-        Gets the set of service principals associated with a Databricks workspace.
+        """Gets the set of service principals associated with a Databricks workspace.
 
         :param attributes: str (optional)
           Comma-separated list of attributes to return in response.
@@ -3970,9 +3892,7 @@ class ServicePrincipalsAPI:
             query["startIndex"] += len(json["Resources"])
 
     def patch(self, id: str, *, operations: Optional[List[Patch]] = None, schemas: Optional[List[PatchSchema]] = None):
-        """Update service principal details.
-
-        Partially updates the details of a single service principal in the Databricks workspace.
+        """Partially updates the details of a single service principal in the Databricks workspace.
 
         :param id: str
           Unique ID in the Databricks workspace.
@@ -4006,9 +3926,7 @@ class ServicePrincipalsAPI:
         roles: Optional[List[ComplexValue]] = None,
         schemas: Optional[List[ServicePrincipalSchema]] = None,
     ):
-        """Replace service principal.
-
-        Updates the details of a single service principal.
+        """Updates the details of a single service principal.
 
         This action replaces the existing service principal with the same name.
 
@@ -4087,9 +4005,7 @@ class UsersAPI:
         schemas: Optional[List[UserSchema]] = None,
         user_name: Optional[str] = None,
     ) -> User:
-        """Create a new user.
-
-        Creates a new user in the Databricks workspace. This new user will also be added to the Databricks
+        """Creates a new user in the Databricks workspace. This new user will also be added to the Databricks
         account.
 
         :param active: bool (optional)
@@ -4153,9 +4069,7 @@ class UsersAPI:
         return User.from_dict(res)
 
     def delete(self, id: str):
-        """Delete a user.
-
-        Deletes a user. Deleting a user from a Databricks workspace also removes objects associated with the
+        """Deletes a user. Deleting a user from a Databricks workspace also removes objects associated with the
         user.
 
         :param id: str
@@ -4180,9 +4094,7 @@ class UsersAPI:
         sort_order: Optional[GetSortOrder] = None,
         start_index: Optional[int] = None,
     ) -> User:
-        """Get user details.
-
-        Gets information for a specific user in Databricks workspace.
+        """Gets information for a specific user in Databricks workspace.
 
         :param id: str
           Unique ID for a user in the Databricks workspace.
@@ -4233,9 +4145,7 @@ class UsersAPI:
         return User.from_dict(res)
 
     def get_permission_levels(self) -> GetPasswordPermissionLevelsResponse:
-        """Get password 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.
 
         :returns: :class:`GetPasswordPermissionLevelsResponse`
         """
@@ -4248,9 +4158,7 @@ class UsersAPI:
         return GetPasswordPermissionLevelsResponse.from_dict(res)
 
     def get_permissions(self) -> PasswordPermissions:
-        """Get password permissions.
-
-        Gets the permissions of all passwords. Passwords can inherit permissions from their root object.
+        """Gets the permissions of all passwords. Passwords can inherit permissions from their root object.
 
         :returns: :class:`PasswordPermissions`
         """
@@ -4273,9 +4181,7 @@ class UsersAPI:
         sort_order: Optional[ListSortOrder] = None,
         start_index: Optional[int] = None,
     ) -> Iterator[User]:
-        """List users.
-
-        Gets details for all the users associated with a Databricks workspace.
+        """Gets details for all the users associated with a Databricks workspace.
 
         :param attributes: str (optional)
           Comma-separated list of attributes to return in response.
@@ -4339,9 +4245,7 @@ class UsersAPI:
             query["startIndex"] += len(json["Resources"])
 
     def patch(self, id: str, *, operations: Optional[List[Patch]] = None, schemas: Optional[List[PatchSchema]] = None):
-        """Update user details.
-
-        Partially updates a user resource by applying the supplied operations on specific user attributes.
+        """Partially updates a user resource by applying the supplied operations on specific user attributes.
 
         :param id: str
           Unique ID in the Databricks workspace.
@@ -4365,9 +4269,7 @@ class UsersAPI:
     def set_permissions(
         self, *, access_control_list: Optional[List[PasswordAccessControlRequest]] = None
     ) -> PasswordPermissions:
-        """Set password permissions.
-
-        Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
+        """Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
         permissions if none are specified. Objects can inherit permissions from their root object.
 
         :param access_control_list: List[:class:`PasswordAccessControlRequest`] (optional)
@@ -4400,9 +4302,7 @@ class UsersAPI:
         schemas: Optional[List[UserSchema]] = None,
         user_name: Optional[str] = None,
     ):
-        """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.
 
         :param id: str
           Databricks user ID.
@@ -4463,9 +4363,7 @@ class UsersAPI:
     def update_permissions(
         self, *, access_control_list: Optional[List[PasswordAccessControlRequest]] = None
     ) -> PasswordPermissions:
-        """Update password permissions.
-
-        Updates the permissions on all passwords. Passwords can inherit permissions from their root object.
+        """Updates the permissions on all passwords. Passwords can inherit permissions from their root object.
 
         :param access_control_list: List[:class:`PasswordAccessControlRequest`] (optional)
 
@@ -4491,9 +4389,7 @@ class WorkspaceAssignmentAPI:
         self._api = api_client
 
     def delete(self, workspace_id: int, principal_id: int):
-        """Delete permissions assignment.
-
-        Deletes the workspace permissions assignment in a given account and workspace for the specified
+        """Deletes the workspace permissions assignment in a given account and workspace for the specified
         principal.
 
         :param workspace_id: int
@@ -4515,9 +4411,7 @@ class WorkspaceAssignmentAPI:
         )
 
     def get(self, workspace_id: int) -> WorkspacePermissions:
-        """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.
 
         :param workspace_id: int
           The workspace ID.
@@ -4537,9 +4431,7 @@ class WorkspaceAssignmentAPI:
         return WorkspacePermissions.from_dict(res)
 
     def list(self, workspace_id: int) -> Iterator[PermissionAssignment]:
-        """Get permission assignments.
-
-        Get the permission assignments for the specified Databricks account and Databricks workspace.
+        """Get the permission assignments for the specified Databricks account and Databricks workspace.
 
         :param workspace_id: int
           The workspace ID for the account.
@@ -4562,9 +4454,7 @@ class WorkspaceAssignmentAPI:
     def update(
         self, workspace_id: int, principal_id: int, *, permissions: Optional[List[WorkspacePermission]] = None
     ) -> PermissionAssignment:
-        """Create or update permissions assignment.
-
-        Creates or updates the workspace permissions assignment in a given account and workspace for the
+        """Creates or updates the workspace permissions assignment in a given account and workspace for the
         specified principal.
 
         :param workspace_id: int