@zilliz/milvus2-sdk-node 2.3.5 → 2.4.1

package/dist/milvus/grpc/User.d.ts

@@ -2,412 +2,380 @@ import { Resource } from './Resource';
 import { CreateUserReq, DeleteUserReq, ListUsersReq, UpdateUserReq, CreateRoleReq, DropRoleReq, AddUserToRoleReq, RemoveUserFromRoleReq, SelectRoleReq, SelectUserReq, OperateRolePrivilegeReq, SelectGrantReq, ListGrantsReq, HasRoleReq, listRoleReq, GrpcTimeOut, ListCredUsersResponse, ResStatus, SelectRoleResponse, SelectUserResponse, SelectGrantResponse, HasRoleResponse } from '../';
 export declare class User extends Resource {
     /**
-     * Create user in milvus
+     * Creates a new user in Milvus.
      *
-     * @param data
-     *  | Property | Type  | Description |
-     *  | :-- | :-- | :-- |
-     *  | username | String | username |
-     *  | password | String | user password |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     * @param {CreateUserReq} data - The user data.
+     * @param {string} data.username - The username of the new user.
+     * @param {string} data.password - The password for the new user.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause|
+     * @returns {Promise<ResStatus>} The response status.
+     * @returns {number} ResStatus.error_code - The error code number.
+     * @returns {string} ResStatus.reason - The cause of the error, if any.
      *
-     * #### Example
-     *
-     * ```
+     * @example
+     * ```javascript
      *  milvusClient.createUser({
-     *    username: NAME,
-     *    password: PASSWORD,
+     *    username: 'exampleUser',
+     *    password: 'examplePassword',
      *  });
      * ```
      */
     createUser(data: CreateUserReq): Promise<ResStatus>;
     /**
-     * Update user in milvus
+     * Update user in Milvus.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | username | String | username |
-     *  | password | String | user password |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     * @param {UpdateUserReq} data - The user data.
+     * @param {string} data.username - The username of the user to be updated.
+     * @param {string} data.newPassword - The new password for the user.
+     * @param {string} data.oldPassword - The old password of the user.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause|
+     * @returns {Promise<ResStatus>} The response status.
+     * @returns {number} ResStatus.error_code - The error code number.
+     * @returns {string} ResStatus.reason - The cause of the error, if any.
      *
-     * #### Example
-     *
-     * ```
+     * @example
+     * ```javascript
      *  milvusClient.updateUser({
-     *    username: NAME,
-     *    newPassword: PASSWORD,
-     *    oldPassword: PASSWORD,
+     *    username: 'exampleUser',
+     *    newPassword: 'newPassword',
+     *    oldPassword: 'oldPassword',
      *  });
      * ```
      */
     updateUser(data: UpdateUserReq): Promise<ResStatus>;
+    updatePassword: (data: UpdateUserReq) => Promise<ResStatus>;
     /**
-     * Delete user in milvus
+     * Lists all users in Milvus.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | username | String | username |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     * @param {Object} data - The data object.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause|
+     * @returns {Promise<Object>} The response object.
+     * @returns {Object} response.status - The response status.
+     * @returns {number} response.status.error_code - The error code number.
+     * @returns {string} response.status.reason - The cause of the error, if any.
+     * @returns {string[]} response.usernames - An array of usernames.
      *
-     * #### Example
-     *
-     * ```
-     *  milvusClient.deleteUser({
-     *    username: NAME,
-     *  });
+     * @example
+     * ```javascript
+     *  milvusClient.listUsers();
      * ```
      */
     deleteUser(data: DeleteUserReq): Promise<ResStatus>;
+    dropUser: (data: DeleteUserReq) => Promise<ResStatus>;
     /**
-     * List user in milvus
+     * Lists all users in Milvus.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     * @param {ListUsersReq} data - The data object.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | usernames | string[] |
+     * @returns {Promise<ListCredUsersResponse>} The response object.
+     * @returns {ResStatus} response.status - The response status.
+     * @returns {number} response.status.error_code - The error code number.
+     * @returns {string} response.status.reason - The cause of the error, if any.
+     * @returns {string[]} response.usernames - An array of usernames.
      *
-     * #### Example
-     *
-     * ```
+     * @example
+     * ```javascript
      *  milvusClient.listUsers();
      * ```
      */
     listUsers(data?: ListUsersReq): Promise<ListCredUsersResponse>;
     /**
-     * Create user role
+     * Create a new role in Milvus.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | roleName | String | role name |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     * @param {CreateRoleReq} data - The role data.
+     * @param {string} data.roleName - The name of the new role.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | reason | '' |
+     * @returns {Promise<ResStatus>} The response status.
+     * @returns {number} ResStatus.error_code - The error code number.
+     * @returns {string} ResStatus.reason - The cause of the error, if any.
      *
-     * #### Example
-     *
-     * ```
-     *  milvusClient.createRole({roleName: 'myrole'});
+     * @example
+     * ```javascript
+     *  milvusClient.createRole({
+     *    roleName: 'exampleRole',
+     *  });
      * ```
      */
     createRole(data: CreateRoleReq): Promise<ResStatus>;
     /**
-     * Drop user role
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | roleName | String | User name |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     * Drops a user role in Milvus.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | reason | '' |
+     * @param {DropRoleReq} data - The data object.
+     * @param {string} data.roleName - The name of the role to be dropped.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
-     * #### Example
+     * @returns {Promise<ResStatus>} The response status.
+     * @returns {number} ResStatus.error_code - The error code number.
+     * @returns {string} ResStatus.reason - The cause of the error, if any.
      *
-     * ```
-     *  milvusClient.dropRole({roleName: 'myrole'});
+     * @example
+     * ```javascript
+     *  milvusClient.dropRole({
+     *    roleName: 'exampleRole',
+     *  });
      * ```
      */
     dropRole(data: DropRoleReq): Promise<ResStatus>;
     /**
-     * add user to role
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | username | String | User name |
-     *  | roleName | String | Role name |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | reason | '' |
-     *
-     * #### Example
-     *
-     * ```
-     *  milvusClient.addUserToRole({username: 'my', roleName: 'myrole'});
+     * Adds a user to a role.
+     *
+     * @param {AddUserToRoleReq} data - The data object.
+     * @param {string} data.username - The username of the user to be added to the role.
+     * @param {string} data.roleName - The name of the role to which the user will be added.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
+     *
+     * @returns {Promise<ResStatus>} The response status.
+     * @returns {number} ResStatus.error_code - The error code number.
+     * @returns {string} ResStatus.reason - The cause of the error, if any.
+     *
+     * @example
+     * ```javascript
+     *  milvusClient.addUserToRole({
+     *    username: 'my',
+     *    roleName: 'myrole'
+     *  });
      * ```
      */
     addUserToRole(data: AddUserToRoleReq): Promise<ResStatus>;
+    grantRole: (data: AddUserToRoleReq) => Promise<ResStatus>;
     /**
-     * remove user from role
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | username | String | User name |
-     *  | roleName | String | Role name |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | reason | '' |
-     *
-     * #### Example
-     *
-     * ```
-     *  milvusClient.removeUserFromRole({username: 'my', roleName: 'myrole'});
+     * Removes a user from a role.
+     *
+     * @param {RemoveUserFromRoleReq} data - The data object.
+     * @param {string} data.username - The username of the user to be removed from the role.
+     * @param {string} data.roleName - The name of the role from which the user will be removed.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
+     *
+     * @returns {Promise<ResStatus>} The response status.
+     * @returns {number} ResStatus.error_code - The error code number.
+     * @returns {string} ResStatus.reason - The cause of the error, if any.
+     *
+     * @example
+     * ```javascript
+     *  milvusClient.removeUserFromRole({
+     *    username: 'my',
+     *    roleName: 'myrole'
+     *  });
      * ```
      */
     removeUserFromRole(data: RemoveUserFromRoleReq): Promise<ResStatus>;
+    revokeRole: (data: RemoveUserFromRoleReq) => Promise<ResStatus>;
     /**
-     * gets all users that belong to a specified role
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | roleName | String | Role name |
-     *  | includeUserInfo? | boolean | should result including user info, by default: true |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
-  
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | results | { users: {name: string}[]; role: {name: string} }[] |
-     *
-     * #### Example
-     *
-     * ```
-     *  milvusClient.selectRole({roleName: 'myrole'});
+     * Gets all users that belong to a specified role.
+     *
+     * @param {Object} data - The data object.
+     * @param {string} data.roleName - The name of the role.
+     * @param {boolean} [data.includeUserInfo=true] - Determines whether the result should include user info.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
+     *
+     * @returns {Promise<Object>} The response object.
+     * @returns {Object} response.status - The response status.
+     * @returns {number} response.status.error_code - The error code number.
+     * @returns {string} response.status.reason - The cause of the error, if any.
+     * @returns {Object[]} response.results - An array of objects, each containing a list of users and a role.
+     * @returns {Object[]} response.results.users - An array of user objects.
+     * @returns {string} response.results.users.name - The name of the user.
+     * @returns {Object} response.results.role - The role object.
+     * @returns {string} response.results.role.name - The name of the role.
+     *
+     * @example
+     * ```javascript
+     *  milvusClient.describeRole({roleName: 'myrole'});
      * ```
      */
-    selectRole(data: SelectRoleReq): Promise<SelectRoleResponse>;
+    describeRole(data: SelectRoleReq): Promise<SelectRoleResponse>;
+    selectRole: (data: SelectRoleReq) => Promise<SelectRoleResponse>;
     /**
-     * list all roles
+     * Lists all roles in Milvus.
      *
-     *  @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     * @param {Object} data - The data object.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | reason | '' |
+     * @returns {Promise<Object>} The response object.
+     * @returns {Object} response.status - The response status.
+     * @returns {number} response.status.error_code - The error code number.
+     * @returns {string} response.status.reason - The cause of the error, if any.
+     * @returns {Object[]} response.results - An array of objects, each containing a role.
+     * @returns {string} response.results.role.name - The name of the role.
      *
-     * #### Example
-     *
-     * ```
+     * @example
+     * ```javascript
      *  milvusClient.listRoles();
      * ```
      */
     listRoles(data?: listRoleReq): Promise<SelectRoleResponse>;
     /**
-     * gets all users that belong to a specified role
-     *
-     *  @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | userName | String | User name |
-     *  | includeUserInfo? | boolean | should result including user info, by default: true |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | results | user: {name: string}; roles: {name: string}[] |
-     *
-     * #### Example
-     *
-     * ```
-     *  milvusClient.selectUser({username: 'name'});
+     * Gets all users that belong to a specified role.
+     *
+     * @param {Object} data - The data object.
+     * @param {string} data.userName - The username of the user.
+     * @param {boolean} [data.includeUserInfo=true] - Determines whether the result should include user info.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
+     *
+     * @returns {Promise<Object>} The response object.
+     * @returns {Object} response.status - The response status.
+     * @returns {number} response.status.error_code - The error code number.
+     * @returns {string} response.status.reason - The cause of the error, if any.
+     * @returns {Object[]} response.results - An array of objects, each containing a user and a list of roles.
+     * @returns {Object} response.results.user - The user object.
+     * @returns {string} response.results.user.name - The name of the user.
+     * @returns {Object[]} response.results.roles - An array of role objects.
+     * @returns {string} response.results.roles.name - The name of the role.
+     *
+     * @example
+     * ```javascript
+     *  milvusClient.describeUser({username: 'name'});
      * ```
      */
-    selectUser(data: SelectUserReq): Promise<SelectUserResponse>;
+    describeUser(data: SelectUserReq): Promise<SelectUserResponse>;
+    selectUser: (data: SelectUserReq) => Promise<SelectUserResponse>;
     /**
-     * grant privileges to a role
-     *
-     *  @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | roleName | String | Role name |
-     *  | object | string | Type of the operational object to which the specified privilege belongs, such as Collection, Index, Partition, etc. This parameter is case-sensitive.|
-     *  | objectName | string | Name of the object to which the role is granted the specified prvilege. |
-     *  | privilegeName | string | Name of the privilege to be granted to the role. This parameter is case-sensitive. |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | reason | '' |
-     *
-     * #### Example
-     *
-     * ```
-     *  milvusClient.grantRolePrivilege({
+     * Grants privileges to a role.
+     *
+     * @param {Object} data - The data object.
+     * @param {string} data.roleName - The name of the role.
+     * @param {string} data.object - The type of the operational object to which the specified privilege belongs, such as Collection, Index, Partition, etc. This parameter is case-sensitive.
+     * @param {string} data.objectName - The name of the object to which the role is granted the specified privilege.
+     * @param {string} data.privilegeName - The name of the privilege to be granted to the role. This parameter is case-sensitive.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
+     *
+     * @returns {Promise<Object>} The response object.
+     * @returns {Object} response.status - The response status.
+     * @returns {number} response.status.error_code - The error code number.
+     * @returns {string} response.status.reason - The cause of the error, if any.
+     *
+     * @example
+     * ```javascript
+     *  milvusClient.grantPrivilege({
      *    roleName: 'roleName',
      *    object: '*',
      *    objectName: 'Collection',
      *    privilegeName: 'CreateIndex'
-     * });
+     *  });
      * ```
      */
-    grantRolePrivilege(data: OperateRolePrivilegeReq): Promise<ResStatus>;
+    grantPrivilege(data: OperateRolePrivilegeReq): Promise<ResStatus>;
+    grantRolePrivilege: (data: OperateRolePrivilegeReq) => Promise<ResStatus>;
     /**
-     * revoke privileges to a role
-     *
-     *  @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | roleName | String | Role name |
-     *  | object | string | Type of the operational object to which the specified privilege belongs, such as Collection, Index, Partition, etc. This parameter is case-sensitive.|
-     *  | objectName | string | Name of the object to which the role is granted the specified prvilege. |
-     *  | privilegeName | string | Name of the privilege to be granted to the role. This parameter is case-sensitive. |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :------------- | :-------- |
-     *  | status | { error_code: number, reason: string } |
-     *  | reason | '' |
-     *
-     * #### Example
-     *
-     * ```
-     *  milvusClient.grantRolePrivilege({
+     * Revokes privileges from a role.
+     *
+     * @param {Object} data - The data object.
+     * @param {string} data.roleName - The name of the role.
+     * @param {string} data.object - The type of the operational object from which the specified privilege is revoked, such as Collection, Index, Partition, etc. This parameter is case-sensitive.
+     * @param {string} data.objectName - The name of the object from which the role's specified privilege is revoked.
+     * @param {string} data.privilegeName - The name of the privilege to be revoked from the role. This parameter is case-sensitive.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
+     *
+     * @returns {Promise<Object>} The response object.
+     * @returns {Object} response.status - The response status.
+     * @returns {number} response.status.error_code - The error code number.
+     * @returns {string} response.status.reason - The cause of the error, if any.
+     *
+     * @example
+     * ```javascript
+     *  milvusClient.revokePrivilege({
      *    roleName: 'roleName',
      *    object: '*',
      *    objectName: 'Collection',
      *    privilegeName: 'CreateIndex'
-     * });
+     *  });
      * ```
      */
-    revokeRolePrivilege(data: OperateRolePrivilegeReq): Promise<ResStatus>;
+    revokePrivilege(data: OperateRolePrivilegeReq): Promise<ResStatus>;
+    revokeRolePrivilege: (data: OperateRolePrivilegeReq) => Promise<ResStatus>;
     /**
-     * revoke all roles priviledges
-     *  @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     * Revokes all privileges from all roles.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | reason | '' |
+     * @param {Object} data - The data object.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
-     * #### Example
+     * @returns {Promise<ResStatus[]>} - An array of response statuses for each role.
+     * @returns {number} ResStatus.error_code - The error code number for each role.
+     * @returns {string} ResStatus.reason - The cause of the error, if any, for each role.
      *
-     * ```
+     * @example
+     * ```javascript
      *  milvusClient.revokeAllRolesPrivileges();
      * ```
      */
     dropAllRoles(data?: GrpcTimeOut): Promise<ResStatus[]>;
     /**
-     * select a grant
-     *  @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | roleName | String | Role name |
-     *  | object | string | Type of the operational object to which the specified privilege belongs, such as Collection, Index, Partition, etc. This parameter is case-sensitive.|
-     *  | objectName | string | Name of the object to which the role is granted the specified prvilege. |
-     *  | privilegeName | string | Name of the privilege to be granted to the role. This parameter is case-sensitive. |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | reason | '' |
-     *
-     * #### Example
-     *
-     * ```
+     * Selects a grant for a specific role.
+     *
+     * @param {Object} data - The data object.
+     * @param {string} data.roleName - The name of the role.
+     * @param {string} data.object - The type of the operational object to which the specified privilege belongs, such as Collection, Index, Partition, etc. This parameter is case-sensitive.
+     * @param {string} data.objectName - The name of the object to which the role is granted the specified privilege.
+     * @param {string} data.privilegeName - The name of the privilege to be granted to the role. This parameter is case-sensitive.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
+     *
+     * @returns {Promise<Object>} The response object.
+     * @returns {Object} response.status - The response status.
+     * @returns {number} response.status.error_code - The error code number.
+     * @returns {string} response.status.reason - The cause of the error, if any.
+     *
+     * @example
+     * ```javascript
      *  milvusClient.selectGrant({
      *    roleName: 'roleName',
      *    object: '*',
      *    objectName: 'Collection',
      *    privilegeName: 'CreateIndex'
-     * });
+     *  });
      * ```
      */
     selectGrant(data: SelectGrantReq): Promise<SelectGrantResponse>;
     /**
-     * list all grants for a role
-     *  @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | roleName | String | Role name |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | reason | '' |
-     *
-     * #### Example
-     *
-     * ```
+     * Lists all grants for a specific role.
+     *
+     * @param {Object} data - The data object.
+     * @param {string} data.roleName - The name of the role.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
+     *
+     * @returns {Promise<SelectGrantResponse>} The response object.
+     * @returns {Object} response.status - The response status.
+     * @returns {number} response.status.error_code - The error code number.
+     * @returns {string} response.status.reason - The cause of the error, if any.
+     * @returns {Object[]} response.entities - An array of entities, each containing a role, an object, an object name, and a grantor.
+     * @returns {Object} response.entities.role - The role object.
+     * @returns {string} response.entities.role.name - The name of the role.
+     * @returns {Object} response.entities.object - The object to which the specified privilege belongs.
+     * @returns {string} response.entities.object.name - The name of the object.
+     * @returns {string} response.entities.object_name - The name of the object to which the role is granted the specified privilege.
+     * @returns {Object} response.entities.grantor - The grantor object.
+     * @returns {string} response.entities.grantor.privilege.name - The name of the privilege granted to the role.
+     *
+     * @example
+     * ```javascript
      *  milvusClient.listGrants({
      *    roleName: 'roleName',
-     * });
+     *  });
      * ```
      */
     listGrants(data: ListGrantsReq): Promise<SelectGrantResponse>;
     /**
-     * check if the role is existing
-     *  @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | roleName | String | Role name |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     * Checks if a role exists.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | reason | '' |
+     * @param {HasRoleReq} data - The data object.
+     * @param {string} data.roleName - The name of the role.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
-     * #### Example
+     * @returns {Promise<HasRoleResponse>} The response object.
+     * @returns {ResStatus} response.status - The response status.
+     * @returns {number} response.status.error_code - The error code number.
+     * @returns {string} response.status.reason - The cause of the error, if any.
+     * @returns {boolean} response.hasRole - A boolean indicating whether the role exists.
      *
-     * ```
+     * @example
+     * ```javascript
      *  milvusClient.hasRole({
      *    roleName: 'roleName',
-     * });
+     *  });
      * ```
      */
     hasRole(data: HasRoleReq): Promise<HasRoleResponse>;